Update documentation for 5.1.5

doc/salome/gui/SMESH/input/2d_meshing_hypo.doc

@@ -49,7 +49,7 @@ length calculated as an average edge length for a given wire.
 
 <b>Base vertex</b> parameter allows using Quadrangle (Mapping)
 algorithm for meshing of triangular faces. In this case it is
-necessary to select a vertex, which will be used as the fourth edge
+necessary to select the vertex, which will be used as the fourth edge
 (degenerated).
 
 \image html hypo_quad_params_1.png "A face built from 3 edges"
@@ -68,31 +68,31 @@ shows the good (left) and the bad (right) results of meshing.
 
 \image html hypo_quad_params_res_2.png "The resulting meshes"
 
-<b>Type</b> parameter has sense on faces with different number of
+<b>Type</b> parameter is used on faces with a different number of
-segments on opposite sides. The following types are available:
+segments on opposite sides to define the algorithm of transition
+between them. The following types are available:
 
 <ul>
-<li><b>Standard</b> means the default case, triangles and quadrangles
+<li><b>Standard</b> is the default case, when both triangles and quadrangles
-    are possible along the longest sides (in the refinement area).</li>
+    are possible in the transition area along the finer meshed sides.</li>
 <li><b>Triangle preference</b> forces building only triangles in the
-    refinement area for transition to higher number of segments.
+    transition area along the finer meshed sides.
     <i>This type corresponds to <b>Triangle Preference</b> additional
     hypothesis, which is obsolete now.</i></li>
-<li><b>Quadrangle preference</b> forces building only quadrangles for
+<li><b>Quadrangle preference</b> forces building only quadrangles in the
-    transition to higher number of segments. This hypothesis has one
+    transition area along the finer meshed sides. This hypothesis has a
-    restriction on its work: the total quantity of segments on all
+    restriction: the total quantity of segments on all
     four sides of the face must be even (divisible by 2).</li>
     <i>This type corresponds to <b>Quadrangle Preference</b>
     additional hypothesis, which is obsolete now.</i></li>
-<li><b>Quadrangle preference (reversed)</b> works like
+<li><b>Quadrangle preference (reversed)</b> works in the same way and
-    <b>Quadrangle preference</b> (and with same restriction), but
+with the same restriction as <b>Quadrangle preference</b>, but
-    transition is made near the sides with smaller number of
+    the transition area is located along the coarser meshed sides.</li>
-    segments.</li>
+<li><b>Reduced</b> type forces building only quadrangles and the transition
-<li><b>Reduced</b> type forces building only quadrangles, transition
+    between the sides is made gradually, layer by layer. This type has
-    to other number of segments is made layer by layer. This type has
+    a limitation on the number of segments: one pair of opposite sides must have
-    a limitation on number of segments: two opposite edges must have
+    the same number of segments, the other pair must have an even difference
-    the same number of segments, two another must have even difference
+    between the numbers of segments on the sides.</li>
-    between their numbers of segments.</li>
 </ul>
 
 <b>See Also</b> a sample TUI Script of a 

doc/salome/gui/SMESH/input/about_filters.doc

@@ -2,8 +2,8 @@
 
 \page filters_page About filters
 
-\b Filters allows to pick only those mesh elements which satisfy to
+\b Filters allow picking only the mesh elements satisfying to a
-specific condition or set of conditions. Filters can be used to create
+specific condition or a set of conditions. Filters can be used to create
 or edit mesh groups, remove elements from the mesh object, control
 mesh quality by different parameters, etc.
 
@@ -18,15 +18,14 @@ The functinality of mesh filters is available in both GUI and TUI
 modes:
 
 - In GUI, filters are available in some dialog boxes via an additional
-"Set Filters" button, clicking on which opens specific dialog box
+"Set Filters" button, clicking on which opens the dialog box
 allowing to specify the list of filter criterions to be applied to the
-current selection. Follow to the \subpage selection_filter_library_page page to learn more
+current selection. See \subpage selection_filter_library_page page to learn more
 about selection filters and their usage in GUI.
 
-- In Python scripts, filters can be used to choose only some of mesh
+- In Python scripts, filters can be used to choose only some mesh
-  entities (nodes and/or elements) for the operations which require
+  entities (nodes and/or elements) for the operations, which require the
-  list of the entities as input parameter (create/modify group, remove
+  list of entities as input parameter (create/modify group, remove
   nodes/elements, etc). The page \ref tui_filters_page provides
-  examples of the filters usage in the Python scripts.
+  examples of the filters usage in Python scripts.
-
 */

doc/salome/gui/SMESH/input/adding_nodes_and_elements.doc

@@ -27,23 +27,23 @@ following associated submenu will appear:</li>
 
 From this submenu select the type of element which you would like to add to your mesh.
 
-\note All dialogs for adding new node or element to the mesh (except for
+\note All dialogs for new node or element adding to the mesh (except for
-the dialog for 0D elements) provide a possibility to add it
+the dialog for 0D elements) provide the possibility to automatically add
-automatically to the specified group or to create it anew using
+a node or element to the specified group or to create the anew using
-<b>Add to group</b> box, that allows to choose an existing group for
+<b>Add to group</b> box, that allows choosing an existing group for
-the created node or element or to give the name to a new group. By
+the created node or element or giving the name to a new group. By
-default, the <b>Add to group</b> check box is switched off. If user
+default, the <b>Add to group</b> check box is switched off. If the user
 swiches this check box on, the combo box listing all currently
 existing groups of the corresponding type becomes available. By
-default, no any group is selected. In such a case, when user presses
+default, no group is selected. In this case, when the user presses
 <b>Apply</b> or <b>Apply & Close</b> button, the warning message box
-informing the user about the necessity to input new group name is
+informs the user about the necessity to input new group name. The
-shown. The combo box lists both \ref standalone_group "standalone groups"
+combo box lists both \ref standalone_group "standalone groups"
-and \ref group_on_geom "groups on geometry". If the user has 
+and \ref group_on_geom "groups on geometry". If the user chooses a
-chosen the group on geometry, he is warned and proposed to
+group on geometry, he is warned and proposed to
-\ref convert_to_standalone "convert this group to the standalone".
+\ref convert_to_standalone "convert this group to standalone".
-If user refuses converting operation, an operation is cancelled and
+If the user rejects conversion operation, it is cancelled and
-new node/element is not created!
+a new node/element is not created!
 
 </ol>
 

doc/salome/gui/SMESH/input/adding_quadratic_elements.doc

@@ -18,23 +18,23 @@ one of the following:
 
 \image html image152.png
 
-\note All dialogs for adding quadratic element to the mesh
+\note All dialogs for quadratic element adding to the mesh
-provide a possibility to add new element
+provide the possibility to automatically add an element
-automatically to the specified group or to create it anew using
+to the specified group or to create the group anew using
-<b>Add to group</b> box, that allows to choose an existing group for
+<b>Add to group</b> box, that allows choosing an existing group for
-the created node or element or to give the name to a new group. By
+the created node or element or giving the name to a new group. By
-default, the <b>Add to group</b> check box is switched off. If user
+default, the <b>Add to group</b> check box is switched off. If the user
 swiches this check box on, the combo box listing all currently
 existing groups of the corresponding type becomes available. By
-default, no any group is selected. In such a case, when user presses
+default, no group is selected. In this case, when the user presses
 <b>Apply</b> or <b>Apply & Close</b> button, the warning message box
-informing the user about the necessity to input new group name is
+informs the user about the necessity to input a new group name. The
-shown. The combo box lists both \ref standalone_group "standalone groups"
+combo box lists both \ref standalone_group "standalone groups"
-and \ref group_on_geom "groups on geometry". If the user has 
+and \ref group_on_geom "groups on geometry". If the user chooses a
-chosen the group on geometry, he is warned and proposed to
+group on geometry, he is warned and proposed to
-\ref convert_to_standalone "convert this group to the standalone".
+\ref convert_to_standalone "convert this group to standalone".
-If user refuses converting operation, an operation is cancelled and
+If the user rejects conversion operation, it is cancelled and
-new node/element is not created!
+a new quadratic element is not created.
 
 
 To create any <b>Quadratic Element</b> specify the nodes which will form your

doc/salome/gui/SMESH/input/creating_groups.doc

@@ -26,7 +26,7 @@ SALOME Platform distinguishes between the two Group types:
 \anchor standalone_group <br><h2>"Standalone Group"</h2>
 
 <b>Standalone Group</b> consists of mesh elements, which you can define in
-the next possible ways:
+the following ways:
 <ul>
 <li>Choosing them manually with the mouse in the 3D Viewer. You can
 click on an element in the 3D viewer and it will be highlighted. After
@@ -37,9 +37,8 @@ definite filter to selection of the elements of your group. See more
 about filters on the
 \ref selection_filter_library_page "Selection filter library" page.</li>
 <li>By adding all existing entities of the chosen type to the
-group. For this purpose, it is necessary to turn on the <b>Select
+group. For this turn on the <b>Select All</b> check box. In this
-All</b> check box. In this mode, all controls which allow selection of
+mode all controls, which allow selecting the entities manually or by filters, are disabled.</li>
-the entities manually or by filters, are disabled.</li>
 </ul>
 To remove a selected element or elements from the list click the
 \b Remove button. The <b>Sort List</b> button allows to sort the list of IDs of

doc/salome/gui/SMESH/input/double_nodes_page.doc

@@ -1,6 +1,6 @@
 /*!
 
-\page double_nodes_page Duplicating Nodes
+\page double_nodes_page Duplicate Nodes
 
 \n This operation allows to duplicate nodes of your mesh.
 

doc/salome/gui/SMESH/input/index.doc

@@ -25,6 +25,10 @@ array of dedicated operations.</li>
 Almost all mesh module functionalities are accessible via
 \subpage smeshpy_interface_page "Mesh module Python interface".
 
+Also it can be useful to have a look at the
+\subpage smeshpypkg_page "documentation on SMESH python package". 
+
+
 \image html image7.jpg "Example of MESH module usage for engineering tasks"
 
 */

doc/salome/gui/SMESH/input/make_2dmesh_from_3d.doc

@@ -1,6 +1,6 @@
 /*!
 
-\page make_2dmesh_from_3d_page Generate the skin elements (2D) of a mesh having 3D elements
+\page make_2dmesh_from_3d_page Create 2D mesh from 3D
 
 \n This functionality allows to generate 2D mesh elements as a skin
 on the existing 3D mesh elements.

doc/salome/gui/SMESH/input/modifying_meshes.doc

@@ -18,7 +18,9 @@ elements of the mesh.</li>
 its elements.</li>
 <li>\subpage rotation_page "Rotate" by the indicated axis and angle
 the mesh or some of its elements.</li>
-<li>\subpage scale_page "Scale Transform" the mesh or some of its elements.</li>
+<li>\subpage scale_page "Scale Transform" the mesh or some of its
+elements.</li>
+<li>\subpage double_nodes_page "Duplicate nodes".</li>
 <li>Create a \subpage symmetry_page "symmetrical copy" of the mesh
 through a point or a vector of symmetry.</li>
 <li>Unite meshes by \subpage sewing_meshes_page "sewing" free borders,
@@ -45,7 +47,6 @@ of the selected node or edge.</li>
 <li>Apply \subpage pattern_mapping_page "pattern mapping".</li>
 <li>\subpage convert_to_from_quadratic_mesh_page "Convert regular mesh to quadratic", 
 or vice versa.</li>
-<li>Create \subpage double_nodes_page "double nodes".</li>
 <li>\subpage make_2dmesh_from_3d_page "Create 2D mesh from 3D".</li>
 
 </ul>

doc/salome/gui/SMESH/input/pattern_mapping.doc

@@ -5,33 +5,31 @@
 <br><h2>About patterns</h2>
 
 The pattern describes a mesh to generate: positions of nodes within a
-geometrical domain and nodal connectivity of elements. As well, a
+geometrical domain and nodal connectivity of elements. A
-pattern specifies the so-called key-points, i.e. nodes that will be
+pattern also specifies the so-called key-points, i.e. the nodes that will be
-located at geometrical vertices. Pattern description is stored in
+located at geometrical vertices. The pattern description is stored in
 \<pattern_name\>.smp file.
 
 The smp file contains 4 sections:
 
--# The first line holds the total number of the pattern nodes (N).
+-# The first line indicates the total number of pattern nodes (N).
--# The next N lines describe nodes coordinates. Each line holds 2
+-# The next N lines describe nodes coordinates. Each line contains 2
-coordinates of a node for 2D pattern or 3 cordinates for 3D pattern.
+node coordinates for a 2D pattern or 3 node cordinates for a 3D pattern.
-Note, that for 3D pattern only relateive values in range [0;1] are
+Note, that node coordinates of a 3D pattern can be defined only by relative values in range [0;1].
-valid for coordinates of the nodes.
+-# The key-points line contains the indices of the nodes to be mapped on geometrical
--# A key-points line: indices of nodes to be mapped on geometrical
+vertices (for a 2D pattern only). Index n refers to the node described 
-vertices (for 2D pattern only). An index n refers to a node described 
+on the n-th line of section 2. The index of the first node zero. For a 3D pattern the key points are not specified.
-on an n-th line of section 2. The first node index is zero. For 3D 
+-# The remaining lines describe nodal connectivity of elements, one line
-pattern key points are not specified.
+for each element. Each line holds indices of nodes forming an element.
--# The rest lines describe nodal connectivity of elements, one line
+Index n refers to the node described on the n-th line of section 2.
-for an element. A line holds indices of nodes forming an element. An
+The first node index is zero. There must be 3 or 4 indices on each
-index n refers to a node described on an n-th line of the section
+line for a 2D pattern (only 2d elements are allowed) and 4, 5, 6 or 8
-2. The first node index is zero. There must be 3 or 4 indices on a
+indices for a 3D pattern (only 3d elements are allowed).
-line for 2D pattern (only 2d elements are allowed) and 4, 5, 6 or 8
-indices for 3D pattern (only 3d elements are allowed).
 
-The 2D pattern must contain at least one element and at least one
+A 2D pattern must contain at least one element and at least one
-key-point. All key-points must lay on boundaries.
+key-point. All key-points must lie on boundaries.
 
-The 3D pattern must contain at least one element.
+A 3D pattern must contain at least one element.
 
 An example of a simple 2D pattern smp file:
 
@@ -60,7 +58,7 @@ An example of a simple 2D pattern smp file:
  8 1 2
 \endcode
 
-The image below provides a preview of above described pattern:
+The image below provides a preview of the above pattern:
 
 \image html pattern2d.png
 
@@ -99,38 +97,41 @@ From the \b Modification menu choose the <b>Pattern Mapping</b> item or click
 \image html image98.png
 <center><em>"Pattern mapping" button</em></center>
 
-The following dialog box shall appear:
+The following dialog box will appear:
+
+\n <b>2D pattern</b>
 
 \image html patternmapping1.png
 
-<center><b> 2D Pattern Mapping dialog box</b></center>
+In this dialog you should specify:
+
+<ul>
+   <li> A face with the number of vertices equal to the number of
+     key-points in the pattern; the number of key-points on internal
+     boundaries of the pattern must also be equal to the number of vertices
+     on internal boundaries of the face;</li>
+   <li> A vertex to which the first key-point should be mapped;</li>
+   <li> If the order of key-points is reversed or not. (The order of vertices of
+     a face is counterclockwise looking from the outside).</li>
+</ul>
+
+\n <b>3D pattern</b>
 
 \image html patternmapping2.png
 
-<center><b> 3D Pattern Mapping dialog box</b></center>
+In this dialog you should specify:
-
+<ul>
-To apply a pattern to a geometrical object, you should specify:
+   <li> A 3D block (Solid) object;</li>
-
+   <li> Two vertices that specify the order of nodes in the resulting mesh.</li>
--# For 2D pattern
+</ul>
-   - A face having the number of vertices equal to the number of
-     key-points in the pattern; the number of key-points on internal
-     boundaries of a pattern must also be equal to the number of vertices
-     on internal boundaries of a face;
-   - A vertex to which the first key-point should be mapped;
-   - Reverse or not the order of key-points. (The order of vertices of
-     a face is counterclockwise looking from outside).
--# For 3D pattern
-   - 3D block (Solid) object;
-   - Two vertices that specify the order of nodes in the resulting
-     mesh.
 
 Then you either load a .smp pattern file previously created manually
 by clicking on the <em>"Load pattern"</em> button, or click on the \b
 New button for automatic generation of the pattern.
 
-For an automatic generation you just specify a geometrical face (for
+For automatic generation you should specify a geometrical face (for a
-2D) or solid (for 3d) having a mesh built on it. Mesh nodes lying on
+2D pattern) or a solid (for a 3D pattern) with a mesh built on it. Mesh nodes lying on
-face vertices become key-points of 2D pattern. Additionally, for 2D
+face vertices become key-points of the pattern. Additionally, for a 2D
 pattern you may choose the way of getting nodes coordinates by
 <b>projecting nodes on the face</b> instead of using
 "positions on face" generated by mesher (if there is any). Faces

doc/salome/gui/SMESH/input/removing_nodes_and_elements.doc

@@ -51,14 +51,14 @@ node of your mesh all adjacent elements will be also deleted.
 \anchor removing_orphan_nodes_anchor
 <h2>Removing orphan nodes</h2>
 
-There is a quick way to remove all the orphan (free) nodes.
+There is a quick way to remove all orphan (free) nodes.
 
-<em>To remove the orphan nodes:</em>
+<em>To remove orphan nodes:</em>
 <ol>
 <li>Select your mesh in the Object Browser or in the 3D viewer.</li>
 
 <li>From the <em>Modification</em> menu choose <em>Remove</em> and from the associated
-submenu select the <em>Orphan Nodes</em>, or just click <em>"Remove orphan nodes"</em>
+submenu select <em>Orphan Nodes</em>, or just click <em>"Remove orphan nodes"</em>
 button in the toolbar.
 
 \image html remove_orphan_nodes_icon.png
@@ -68,7 +68,7 @@ The following Warning message box will appear:
 
 \image html removeorphannodes.png
 
-Confirm removing nodes by pressing "Yes" button.
+Confirm nodes removal by pressing "Yes" button.
 </ol>
 
 <br>

doc/salome/gui/SMESH/input/selection_filter_library.doc

@@ -157,10 +157,10 @@ length, which is more, less or equal (within a given <b>Tolerance</b>) to the pr
 <b>Threshold Value</b>. See also a
 \ref length_2d_page "Length 2D quality control".
 </li><li>
-<b>Coplanar faces</b> selects mesh faces neighboring the one defined by
+<b>Coplanar faces</b> selects mesh faces neighboring the one selected
-<b>Threshold Value</b> and whose normal has an angle less then an
+by ID in <b>Threshold Value</b> field, if the angle between the
-angular tolerance (defined in degrees) with normal of the face
+normal to the neighboring face and the normal to the selected face is less then the
-selected as threshold. Selection continues among neighboring faces of already 
+angular tolerance (defined in degrees). Selection continues among all neighbor faces of already 
 selected ones.<br>
 </li>
 </ul>

doc/salome/gui/SMESH/input/tui_filters.doc

@@ -2,8 +2,8 @@
 
 \page tui_filters_page Filters usage
 
-Filters allows to pick only those mesh elements which satisfy to
+Filters allow picking only the mesh elements satisfying to a
-specific condition or set of conditions. Filters can be used to create
+specific condition or a set of conditions. Filters can be used to create
 or edit mesh groups, remove elements from the mesh object, control
 mesh quality by different parameters, etc.
 
@@ -12,10 +12,10 @@ AND and \a OR. In addition, applied filter criterion can be reverted
 using logical operator \a NOT.
 
 Mesh filters use the functionality of mesh quality controls to filter
-mesh nodes / elements by specific characteristic (Area, Length, etc).
+mesh nodes / elements by a specific characteristic (Area, Length, etc).
 
 This page provides a short description of the existing mesh filters,
-describing required parameters and gives simple examples of usage in
+describes required parameters and gives simple examples of usage in
 Python scripts.
 
 \sa \ref tui_quality_controls_page