docs revised

This commit is contained in:
eap 2015-05-27 20:49:30 +03:00
parent 5dd3b79b00
commit 4f3f2d1610
17 changed files with 80 additions and 61 deletions

View File

@ -337,7 +337,8 @@ parameter of the hypotheses depending on edge direction.
geometrical model in the 3D Viewer, which can help to understand the
location of a set of edges within the model.
<b>Propagation chains</b> group allows splitting opposite edges of quadrilateral faces
<b>Propagation chains</b> group allows defining <b>Reversed Edges</b>
for splitting opposite edges of quadrilateral faces
in a logically uniform direction. When this group is
activated, the list is filled with propagation chains found within the
model. When a chain is selected in the list its edges are

View File

@ -15,15 +15,15 @@ The choice of a hypothesis depends on the selected algorithm.
Hypotheses are created during creation and edition of
\ref constructing_meshes_page "meshes" and
\ref constructing_submeshes_page "sub-meshes".
Once created a hypotheses can be reused during creation and
edition of other meshes and sub-meshes. All created hypotheses and
algorithms are present in the Object Browser in \a Hypotheses and
\a Algorithms folders correspondingly. It is possible to open a dialog
to modify the parameters of a hypothesis from its context menu.
This menu also provides \b Unassign command that will unassign the hypothesis from all
meshes and sub-meshes using it.
Modification of any parameter of a hypothesis and its unassignment lead
to automatic removal of elements generated using it.
Once created a hypotheses can be reused during creation and edition of
other meshes and sub-meshes. All created hypotheses and algorithms are
present in the Object Browser in \a Hypotheses and \a Algorithms
folders correspondingly. It is possible to open a dialog to modify the
parameters of a hypothesis from its context menu. This menu also
provides \b Unassign command that will unassign the hypothesis from
all meshes and sub-meshes using it. Modification of any parameter of a
hypothesis and its unassignment leads to automatic removal of elements
generated using it.
In \b MESH there are the following Basic Hypotheses:
<ul>

View File

@ -36,7 +36,8 @@ using the same hypothesis assigned to only one edge.<br>
Thus you define a sub-mesh on the edge where you define 1D meshing
parameters and the \b Propagation hypothesis. These local meshing
parameters will be propagated via opposite sides of quadrangles to the
whole geometry, or to an edge with other local meshing parameters.
whole geometry, and this propagation stops at an edge with other local
meshing parameters.
This hypothesis can be taken into account by
\ref a1d_algos_anchor "Wire Discretization" and
@ -168,8 +169,13 @@ for more information about quadratic meshes.
This additional hypothesis can be used together with 2D triangulation algorithms.
It allows 2D triangulation algorithms to build quadrangular meshes.
This hypothesis cannot be used with "Quadrangle (Mapping)" meshing algorithm,
since \ref hypo_quad_params_anchor "Quadrangle parameters"
hypothesis has a restriction: the total quantity of
segments on all four sides of the face must be even (divisible by 2).
Usage of this hypothesis with "Quadrangle (Mapping)" meshing algorithm
is obsolete since introducing
\ref hypo_quad_params_anchor "Quadrangle parameters" hypothesis.
Usage of this hypothesis with "Quadrangle (Mapping)" meshing algorithm
corresponds to specifying "Quadrangle Preference" transition type of
\ref hypo_quad_params_anchor "Quadrangle parameters" hypothesis.
\note "Quadrangle Preference" transition type can be used only if the
total quantity of segments on all sides of the face is even (divisible
by 2), else "Standard" transition type is used.
*/

View File

@ -19,7 +19,8 @@ number of mesh segments following an 1D hypothesis.
</li>
<li><em>Composite Side Discretization</em> algorithm - allows to apply a 1D
hypothesis to a whole side of a geometrical face even if it is
composed of several edges provided that they form C1 curve in all faces of the main shape.</li>
composed of several edges provided that they form C1 curve in all
faces of the main shape.</li>
</ul>
<li>For meshing of 2D entities (<b>faces</b>):</li>

View File

@ -32,10 +32,11 @@ The following dialog box will appear:
<li><b>Processing identical groups</b> - allows selecting the method
of processing the namesake groups existing in the input meshes.
They can be either <ul>
<li>\b United - all elements of \em Group1 \em of Mesh_1 and \em Group1 of \em Mesh_2
become the elements of \em Group1 of the \em Compound_Mesh, or</li>
<li>\b Renamed - \em Group1 of \em Mesh_1 becomes \em Group1_1 and \em Group1 of \em Mesh_2
becomes \em Group1_2.</li>
<li>\b United - all elements of \em Group1 of \em Mesh_1 and \em
Group1 of \em Mesh_2 become the elements of \em Group1 of the
\em Compound_Mesh, or</li>
<li>\b Renamed - \em Group1 of \em Mesh_1 becomes \em Group1_1
and \em Group1 of \em Mesh_2 becomes \em Group1_2.</li>
</ul>
See \ref grouping_elements_page "Creating Groups" for more information
about groups.</li>

View File

@ -101,9 +101,10 @@ creation and computing) of the following steps:
3D sub-shapes (solids) and generate 3D mesh elements
(tetrahedra, hexahedra etc.)
As soon as you have selected an algorithm, you can create a hypothesis (or
select an already created one). A set of accessible
hypotheses includes only the hypotheses that can be used by the selected algorithm.
As soon as you have selected an algorithm, you can create a
hypothesis (or select an already created one). A set of accessible
hypotheses includes only the hypotheses that can be used by the
selected algorithm.
\note
- Some page(s) can be disabled if the geometrical
@ -115,7 +116,7 @@ creation and computing) of the following steps:
dialog pages related to the corresponding lower dimensions are
disabled.
- \b 0D page refers to 0D geometry (vertices) rather than
to 0D elements. Mesh module does not provide algorithms that
to 0D elements. Mesh module does not provide algorithms that
produce 0D elements. Currently \b 0D page provides only one
algorithm "Segments around vertex" that allows specifying the required
size of mesh edges about the selected vertex (or vertices).
@ -123,8 +124,8 @@ creation and computing) of the following steps:
For example, you need to mesh a 3D object.
First, you can change a default name of your mesh in the \b Name
box. Then check that the selected geometrical object
indicated in \b Geometry field, is what you wish to mesh; if not, select
box. Then check that the selected geometrical object indicated in
\b Geometry field, is what you wish to mesh; if not, select
the correct object in the Object Browser. Click "Select" button
near \b Geometry field if the name of the object has not yet
appeared in \b Geometry field.
@ -221,9 +222,9 @@ creation and computing) of the following steps:
</center>
\note
- \a "Automatic" in the names of predefined sets of
hypotheses does not actually mean that they are suitable for
meshing any geometry.
- \a "Automatic" in the names of predefined sets of hypotheses
does not actually mean that they are suitable for meshing any
geometry.
- The list of sets of hypotheses can be shorter than in the
above image depending on the geometry dimension.
</li>
@ -376,13 +377,13 @@ click "Compute" button of the toolbar.
After the mesh computation finishes, the Mesh Computation information
box appears. If you close this box and click "Compute" button again,
without previously changing meshing parameters, the mesh will
NOT be re-computed and the Mesh Computation information box will be shown with
the same contents. (To fully re-compute the mesh, invoke \ref
clear_mesh_anchor "Clear Mesh Data" command before).
without previously changing meshing parameters, the mesh will NOT be
re-computed and the Mesh Computation information box will be shown
with the same contents. (To fully re-compute the mesh, invoke
\ref clear_mesh_anchor "Clear Mesh Data" command before).
If the mesh computation has been a success, the box shows information on the number of entities
of different types in the mesh.
If the mesh computation has been a success, the box shows information
on the number of entities of different types in the mesh.
\image html meshcomputationsucceed.png

View File

@ -58,7 +58,8 @@ The following dialog will appear:
<li>If the <b>Extrusion to Distance</b> radio button is selected
- specify the translation vector by which the elements will be extruded.
</li>
<p><br></p>
\image html extrusionalongaline2.png
<li>If the <b>Extrusion Along Vector</b> radio button is selected
@ -70,7 +71,8 @@ The following dialog will appear:
be negative).</li>
</ul>
</li>
<p><br></p>
\image html extrusionalongaline3.png
<li>If the <b>Extrusion By Normal</b> radio button is selected,

View File

@ -70,9 +70,9 @@ The created groups can be later:
- \ref importing_exporting_meshes_page "Exported" into a file as a
whole mesh.
In the Object Browser, if an item contains more
than one group, it is possible to sort its groups by name in
ascending order using <b>Sort children</b> context menu item.
In the Object Browser, if an item contains more than one child group,
it is possible to sort the groups by name in ascending order
using <b>Sort children</b> context menu item.
\image html smesh_sort_groups.png "Sorting groups"

View File

@ -4,8 +4,8 @@
\n In MESH there is a functionality allowing import/export
of meshes from/to \b MED, \b UNV (I-DEAS 10), \b DAT (simple ascii format), \b STL,
\b GMF (internal format of DISTENE products, namely BLSurf, GHS3D and
Hexotic algorithms) and \b CGNS format files. You can also export a
\b GMF (internal format of DISTENE products, namely MG-CADSurf, MG-Tetra and
MG-Hexa algorithms) and \b CGNS format files. You can also export a
group as a whole mesh.

View File

@ -16,10 +16,11 @@
either \ref importing_exporting_meshes_page "imported" or manually
created);
</li>
<li>\ref importing_exporting_meshes_page "importing and exporting meshes in various formats";</li>
<li>\ref importing_exporting_meshes_page "importing and exporting meshes in various formats";</li>
<li>\subpage modifying_meshes_page "modifying meshes" with a vast
array of dedicated operations;</li>
<li>\subpage grouping_elements_page "creating groups of mesh elements";</li>
<li>\subpage grouping_elements_page "creating groups of mesh
elements";</li>
<li>filtering mesh entities (nodes or elements) using
\subpage filters_page "Filters" functionality for \ref
grouping_elements_page "creating groups" and applying \ref
@ -27,14 +28,17 @@
<li>\subpage viewing_meshes_overview_page "viewing meshes" in
the VTK viewer;</li>
<li>applying to meshes \subpage quality_page "Quality Controls",
allowing to highlight important elements;
<li>taking various \subpage measurements_page "measurements" of the mesh objects.
allowing to highlight important elements;</li>
<li>taking various \subpage measurements_page "measurements" of the
mesh objects.</li>
</ul>
It is possible to use the variables predefined in
\subpage using_notebook_mesh_page "Salome notebook" to set parameters of operations.
\subpage using_notebook_mesh_page "Salome notebook" to set parameters
of operations.
Mesh module preferences are described in the \subpage mesh_preferences_page section of SALOME Mesh Help.
Mesh module preferences are described in the \subpage mesh_preferences_page
section of SALOME Mesh Help.
Almost all mesh module functionalities are accessible via
\subpage smeshpy_interface_page "Mesh module Python interface".

View File

@ -38,7 +38,8 @@ object selectable in the dialog box. Two elements are considered coincident if t
in the selected object.</li>
<li><b>Coincident elements</b> is a list of groups of elements for
merging. After the operation all elements of each group will
be united into one element.
be united into one element. The first element of a group is kept and
the others are removed.
<ul>
<li>\b Remove button deletes the selected group from the list.</li>
<li>\b Add button adds to the list a group of elements selected in the
@ -57,7 +58,7 @@ object selectable in the dialog box. Two elements are considered coincident if t
<br>
\image html sort.png
<center>moves the selected element to the first position in the
group.</center>
group in order to keep it in the mesh.</center>
<br>
</li>
<li>To confirm your choice click \b Apply or <b>Apply and Close</b> button.</li>

View File

@ -38,9 +38,10 @@ In this mode additional controls are available:
<ul>
<li>\b Detect button generates the list of coincident nodes for the given
\b Tolerance.</li>
<li><b>Coincident nodes</b> is a list of groups of elements for
merging. After the operation all elements of each group will
be united into one element.
<li><b>Coincident nodes</b> is a list of groups of nodes for
merging. After the operation all nodes of each group will
be united into one node. The first node of a group is kept and
the others are removed.
<ul>
<li>\b Remove button deletes the selected group from the list.</li>
<li>\b Add button adds to the list a group of nodes selected in the
@ -65,7 +66,7 @@ nodes of selected groups in the 3D viewer.</li>
<br>
\image html sort.png
<center>moves the selected node to the first position in the
group.</center><br>
group in order to keep it in the mesh.</center><br>
</li>
</ul>
</li>

View File

@ -54,7 +54,7 @@ or in later sessions with this module according to the preferences.
this operation will be carried out automatically.
- <b>Mesh computation</b>
- <b>Show a computation result notification</b> combob-ox allows to
- <b>Show a computation result notification</b> combo-box allows to
select the notification mode about a mesh computation result.
There are 3 possible modes:
- <b>Never</b> - do not show the result dialog at all;

View File

@ -28,7 +28,7 @@ selected criterion. The \b Remove button deletes the selected
criterion. The \b Clear button deletes all criteria.
\n Each <b>Entity type</b> has its specific list of criteria, however all
filters have common syntax. The <b>Threshold Value</b> should be specified
for each criterion. For numerical criteria it is necessary to indicate if
for most criteria. For numerical criteria it is necessary to indicate if
the found elements should be \b More, \b Less or \b Equal to this
\b Value. You can also reverse the sense of a criterion using \b Unary
operator \a Not and you should specify logical relations between
@ -102,7 +102,7 @@ defined by the <b>Threshold Value</b>. The list of available geometric
types depends on the current entity type.
</li><li>
<b>Entity type</b> allows selection of elements by their type defined
as a combination of geometry type amd the number of nodes.
as a combination of geometry type and the number of nodes.
</li>
</ul>

View File

@ -6,7 +6,8 @@
locations of element corners (nodes).
\note Depending on the chosen method and mesh geometry
the smoothing can actually decrease the quality of elements.
the smoothing can actually decrease the quality of elements and even
make some elements inverted.
<em>To apply smoothing to the elements of your mesh:</em>
<ol>

View File

@ -2,7 +2,7 @@
\page uniting_set_of_triangles_page Uniting a set of triangles
\n It is possible to unite many neighboring triangles (cells) into
\n It is possible to unite many neighboring triangles into
quadrangles by deletion of the common edge.
<em>To union several triangles:</em>

View File

@ -2,7 +2,7 @@
\page uniting_two_triangles_page Uniting two triangles
\n In MESH you can union two neighboring triangles (cells) by deletion
\n In MESH you can union two neighboring triangles by deletion
of the common edge.
<em>To unite two triangles:</em>
@ -20,7 +20,7 @@ The following dialog box shall appear:
</li>
<li>Enter IDs of nodes forming the required edge in the \b Edge field
(the node IDs must be separated by dashes) or select this edge in
(a couple of node IDs separated by a dash) or select this edge in
the 3D viewer.</li>
<li>Click the \b Apply or <b>Apply and Close</b> button.</li>
</ol>