Update SMESH documentation

doc/salome/gui/SMESH/input/about_meshes.doc

@@ -18,7 +18,7 @@ Several created meshes can be \subpage building_compounds_page "combined into me
 
 All created meshes and submeshes can be \subpage editing_meshes_page "edited".
 
-Meshes can be also using the MESH functions destined for 
+Meshes can be also edited using the MESH functions destined for 
 \ref modifying_meshes_page "modification" of generated meshes.
 
 The \b topology of a mesh is described by the relationships between its

doc/salome/gui/SMESH/input/create_groups_from_geometry.doc

@@ -0,0 +1,17 @@
+/*!
+
+\page create_groups_from_geometry_page Create Groups from Geometry
+
+To use this operation, select in the \b Mesh menu <b>Create Groups from Geometry</b>.
+
+\image html create_groups_from_geometry.png
+
+This operation allows  creating  on a selected geometry several groups consisting of
+elements of all types.
+ 
+The group names will be the same as the names of geometrical objects.
+The Type of group of mesh elements is defined automatically by the nature of
+the <b>Geometric object</b>.
+
+
+*/

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

@@ -42,16 +42,32 @@ To remove a selected element or elements from the list click the
 mesh elements.
 \n <b>Select from</b> set of fields allows to choose a submesh or an existing
 group whose elements of the previously defined type will be added to
-the list of elements which will form your group.
+the list of elements which will form the new group.
 \n <b>Color</b> - allows to assign to the group a certain color, for
 example, defining boundary conditions. This feature introduces a
 useful element of preprocessing in Mesh module. Note that <b>Color</b> attribute defines
 the colors used for the display of the elements of the group. 
 \n <b>Warning</b> The Med Color group interface may change in future versions of Salome.
 
-
 \image html creategroup.png
 
+For example, to create a new group containing all entities of the
+existing group and some other faces selected in the viewer:
+<ul>
+<li> select the "Face" type of entities and input the name of the new group.</li>
+<li> checks "Group" checkbox in "Select From" group.</li>
+<li> select the existing group in the object browser or in the viewer.</li>
+<li> click "Add" in "Content" group. "Id Elements" list will be filled
+with IDs of faces belonging to the exising group.</li>
+<li> select other faces in the viewer.</li>
+<li> click "Apply" button to create the new group.</li>
+</ul>
+
+Please note that the new group does not have references to the source
+group. It contains only the list of face IDs. So if the old group will
+be changed, the new one will not be modified.
+
+
 \image html image130.gif
 <center>In this picture the brown cells belong to a group defined manually.</center>
 
@@ -74,16 +90,6 @@ a new group of mesh elements will be created.
 
 \image html a-creategroup.png
 
-<br><br>
-To create multiple groups on geometry of both nodes and elements of
-any type at once, in the \b Mesh menu select <b>Create Groups from
-Geometry</b>.<br>
-Group names are same as those of geometrical objects.
-Type of group of mesh elements is defined automatically by 
-<b>Geometrical object</b> nature.
-
-\image html create_groups_from_geometry.png
-
 \image html image132.gif
 <center>In this picture the cells which belong to a certain face are
 selected in green.</center>
@@ -92,58 +98,4 @@ selected in green.</center>
 \ref tui_create_group_on_geometry "Create a Group on Geometry"
 operation.
 
-<br><h2>Creation of groups using existing groups and sub-meshes.</h2>
-
-Application provides possibility to create new <b>standalone</b> groups using existing standalone groups, groups on geometry and sub-meshes. This functionality is implemented using "Select from" group box of "Create group" dialog box described above.
-
-This functionality is described on the example of creating new group   from existing standalone groups and groups on geometry.
-
-Imagine there are group G1. It can be standalone group or group on geometry.
-
-To create group G2 containing all entities of group G1 and a faces graphically selected in 3D view following steps can be performed:
-<ul>
-<li>User opens "Create group" dialog box.</li>
-<li>The user specifies "Face" type of entities and "G2" name of group.</li>
-<li>The user checks "Group" check-box of "Select From" group box.</li>
-<li>The user selects G1 group in object browser or 3D view.</li>
-<li>The user presses "Add" push button of "Content" group box. "Id Elements" list-box is filled with identifiers of faces belonging to group G1.</li>
-<li>The user selects other faces in 3D view.</li>
-<li>The user presses "Apply" button. System creates group G2.</li>
-</ul>
-
-Please note that group G2 does not have a references to source group G1. It contains list of faces identifiers only. So if G1 group will be changed group G2 will remain unmodified.
-
-<br>
-\anchor gui_create_dim_group
-<h2>Creating groups of entities from existing groups of superior dimensions</h2>
-
-Application provides possibility for creating groups of entities from existing groups of superior dimensions. For example, it is possible to create group of nodes using list of existing groups of faces.
-
-To create groups of entities from existing groups of superior dimensions, in the \b Mesh menu select <b>Group of underlying entities</b>.<br>
-
-The following dialog box will appear:
-
-\image html dimgroup_dlg.png
-
-In this dialog box you should specify the name of the resulting group, types of entities and set of source groups.
-
-For example, we have two source Volume groups illustrated on the figure below 
-
-\image html dimgroup_src.png
-<center>Source groups</center>
-
-In this case we obtain following results for Faces, Edges and Nodes.
-
-\image html dimgroup_2d.png
-<center>Faces</center>
-
-\image html dimgroup_1d.png
-<center>Edges</center>
-
-\image html dimgroup_0d.png
-<center>Nodes</center>
-
-<b>See Also</b> a sample TUI Script of a 
-\ref tui_create_dim_group "Creating groups of entities from existing groups of superior dimensions"
-operation.
 */

doc/salome/gui/SMESH/input/extrusion.doc

@@ -39,14 +39,14 @@ viewer; or</li>
 about filters in the \ref selection_filter_library_page "Selection filter library" page.</li>
 </ul>
 </li>
-<li>If the <b>Extrude to Distance</b> Radio Button Selected</li>
+<li>If the <b>Extrude to Distance</b> radio button is selected</li>
 <ul>
 <li>specify the distance at which the elements will be extruded,</li>
 </ul>
-<li>If the <b>Extrude Along Vector</b> Radio Button Selected</li>
+<li>If the <b>Extrude Along Vector</b> radio button is selected</li>
 <ul>
-<li>specify the vector along which the elements will be extruded, or select the face (the normale to the face will be define a vector)</li>
+<li>specify the vector along which the elements will be extruded, or select the face (the normale to the face will define the vector)</li>
-<li>specify the distance to be extruded along this vector,</li>
+<li>specify the distance of extrusion along the vector,</li>
 </ul>
 <li>specify the number of steps;</li>
 <li>activate  <b>Generate Groups</b> checkbox if it is necessary to copy the groups of

doc/salome/gui/SMESH/input/free_faces.doc

@@ -2,12 +2,12 @@
 
 \page free_faces_page Free faces
 
-\n This mesh quality control highlights the faces connected
+\n This mesh quality control highlights the faces connected to
-less than to two mesh volume elements. The free faces are shown with a
+less than two mesh volume elements. The free faces are shown with a
 color different from the color of shared faces.
 
 \image html free_faces.png
-<center>In this picture some volume mesh elements have been, as
+<center>In this picture some volume mesh elements have been removed, as
 a result some faces became connected only to one
 volume. i.e. became free.
 

doc/salome/gui/SMESH/input/ghs3dprl_hypo.doc

@@ -5,17 +5,17 @@
 \n GHS3DPRL Parameters hypothesis works only with <b>Tetrahedron (Tepal with TetMesh-GHS3D)</b> algorithm.
 \n
 \n This algorithm is a commercial software, its use requires a licence (http://www.distene.com/fr/build/offer.html).
-\n The advantage of Tepal is the possibility to generate (for example) a <em>partitioned</em> 
+\n For example, Tepal gives the possibility to generate a partitioned
-200 million tetrahedra mesh on a not-so-big memory computer (2Go RAM) 
+mesh with 200 million tetrahedrons on a computer with average memory size
-...in something like 50 hours of <em>one</em> CPU (Xeon, 2008). 
+(2Go RAM) in about 50 hours on one CPU (Xeon, 2008). 
-This is an alternative to Pluging GHS3D where you should need something like a not-so-common CPU with 64Go RAM 
+This is a serious alternative to GHS3D, which requires a much less common
-<em>to try</em> to do a one-partitionned 200 million tetrahedra mesh ...in a much less time indeed.
+configuration with 64Go RAM to only try to make a partition of a mesh with
+200 million tetrahedrons, no result guaranteed.
 \n
-\n Notes:
+\note The Plugin doesn't load in the Memory the supposedly large resulting meshes. 
-\n This Plugin <em>doesn't</em> load in Memory the supposed plentiful big resulting meshes. 
+The meshes are imported in the user-defined location as MED files via menu File-Import-MED Files.
-It's user choice: (in GUI Mesh mode) menu File-Import-MED Files.
+\n Pay attention, that Salome GUI Salome needs 2Go RAM. to load a MED
-\n Beware, to load one 5 millions tetrahedra MED file, GUI Salome needs 2Go RAM.
+file with 5 million tetrahedrons.
-\n A new true parallel faster version of Tepal, using MPI, is expected in 2009.
 
 \image html ghs3dprl_parameters_basic.png
 
@@ -24,39 +24,41 @@ It's user choice: (in GUI Mesh mode) menu File-Import-MED Files.
 <b>Name</b> - allows to define the name of the hypothesis (GHS3DPRL Parameters by default).
 </li>
 <li>
-<b>MED_Name</b> - allows to define the path and the basename of the 
+<b>MED_Name</b> - allows to define the path and the default name of the 
-generated resulted MED files ("DOMAIN" by default). 
+resulting MED files ("DOMAIN"). 
-Undefined path means environment variable $SALOME_TMP_DIR (or $TMP by default).
+If the path is not defined, the environment variable $SALOME_TMP_DIR
+is used.
 </li>
 <li>
-<b>Nb_Part</b> - allows to define the number of MED files generated, 
+<b>Nb_Part</b> - allows to define the number of generated MED files, 
-the initial skin (triangles) will be meshed (tetrahedra) and partitioned 
+The initial skin (triangles) will be meshed (tetrahedrons) and partitioned 
-in Nb_Part by the <i>elementary</i> algorithm implemented in Tepal.<br>
+in Nb_Part by the elementary algorithm implemented in Tepal.<br>
-Beware, the (expected) number of total tetrahedra versus this parameter 
-involves the maximum tepal RAM use.
 </li>
 <li>
 <b>Keep_Files</b> - if this box is checked, input files of Tepal 
-(GHS3DPRL.points and GHS3DPRL.faces) are deleted after use (...if no backgrounding).
+(GHS3DPRL.points and GHS3DPRL.faces) are deleted after use (...if the
+background mode was not used).
 </li>
 <li>
-<b>Tepal_in_Background</b> - if this box is checked, for big meshes, 
+<b>Tepal_in_Background</b> - if this box is checked, Tepal execution
-launch Tepal execution and MED file generation in background, 
+and MED file generation are launched in background mode and the user
-allows user exiting of Salome. In this case, beware of the 
+can even exit Salome. Pay attention that in this case Tepal algorithm works
-job Tepal is "killSalome.py" <i>independent</i>, sometimes on other host.
+independently of "killSalome.py", and sometimes on another host.
 </li>
 <li>
-<b>To_Mesh_Holes</b> - if this box is checked, force parameter component 
+<b>To_Mesh_Holes</b> - if this box is checked, the parameter component 
-of tetmesh-ghs3d to mesh holes.
+of tetmesh-ghs3d will mesh holes.
 </li>
 
 <h1>Modifying GHS3DPRL Advanced Parameters</h1><br>
-GHS3DPRL Plugin launches standalone binary executable tepal2med which launches binary executable tepal.<br>
+GHS3DPRL Plugin launches a standalone binary executable tepal2med.<br>
-tepal2med launches tepal, wait for the end of computation, and converts resulting output tepal files in expected MED files.<br>
+tepal2med launches tepal, waits for the end of computation, and
-Some advanced optional parameters are accessibles as arguments.<br>
+converts the resulting output tepal files into MED files.<br>
-If keep_files checked you a posteriori can always re-launch tepal2med in a Terminal as a command with yours parameters.<br>Idem for tepal.<br><br>
+Some advanced optional parameters are accessible as arguments.<br>
+If keep_files option is checked, it is possible to re-launch tepal2med
+or tepal in the Terminal as a command with custom parameters.<br>
 <li>
-<b>Advanced tepal2med Parameters</b> - type "tepal2med --help" in a Terminal. <p>
+<b>Advanced tepal2med Parameters</b> - type "tepal2med --help" in the Terminal. <p>
 
 \verbatim
 myname@myhost > /export/home/myname/salome_5/GHS3DPRLPLUGIN_5/bin/salome/tepal2med --help
@@ -108,42 +110,44 @@ myname@myhost > tepal
 
 USAGE : tepal options
 
-With options in :
+With options :
      --filename name (-f name) :
-          Basename of the input case (MANDATORY)
+          Default name of the input case (MANDATORY)
 
      --ndom n (-n n) :
           Number of subdomains to make (MANDATORY)
 
      --ghs3d ghs3d options (-g ghs3d options) :
-          Run temesh ghs3d on a previously generated subdomain. (ghs3d options must be "quoted")
+          Runs temesh ghs3d on a previously generated subdomain. (ghs3d options must be "quoted")
 
      --memory m (-m m) :
           Max amount of memory (megabytes) allowed for ghs in the cutting process. (default is 0 : unlimited)
 
      --mesh_only  (-Z ) :
-          Only (re)mesh all subdomains and update communications messages
+          Only (re)meshes all subdomains and updates communications messages
 
      --mesh_call command (-c command) :
-          Call the user specified command for meshing all the subomains after their skin was generated
+          Calls the user specified command for meshing all the
+          subomains after their skin has been generated
 
      --stats_only  (-S ) :
-          Only compute and show some statistics on subdomains
+          Only computes and shows some statistics on subdomains
 
      --rebuild  (-r ) :
-          Merge final subdomains skins
+          Merges final subdomains skins
 
      --rebuild_tetra  (-R ) :
-          Merge final subdomains skins and tetraedra
+          Merges final subdomains skins and tetraedra
 
      --rebuild_iface  (-i ) :
-          Include interfaces in final subdomains merge
+          Includes interfaces in final subdomains merge
 
      --rebuild_retag  (-t ) :
-          Tag vertices, faces (and tetra if selected) with their subdomain number in final subdomains merge (keeps the lowest tag for shared elements)
+          Tags vertices, faces (and tetra if selected) with their
+          subdomain number in the final merger of subdomains (keeps the lowest tag for shared elements)
 
      --rebuild_ensight_parts  (-e ) :
-          Build ensight geom file with parts
+          Builds ensight geom file with parts
 
      --tetmesh_args str (-G str) :
           Arguments to pass to Tetmesh during cutting process
@@ -177,7 +181,7 @@ DESCRIPTION
 
  -u (-h)        : prints this message.
 
- -m memory      : launches the software with memory Megabytes of work space.
+ -m memory      : launches the software with memory in Megabytes.
                   The default value of this parameter is 64 Megabytes and its
                   minimum value is 10 Megabytes.
                   It is also possible to set this parameter with the
@@ -188,47 +192,45 @@ DESCRIPTION
                   the environment variable.
 
  -M MEMORY      : uses the automatic memory adjustment feature.
-                  If MEMORY is zero, the size of the work space is initially
+                  If MEMORY is equal to zero, the size of the work space is
-                  guessed from the input. If MEMORY is not zero, the
+                  calculated from the input. If MEMORY is not equal to
-                  software starts with MEMORY Megabytes of work space.
+                  zero, the software starts with MEMORY amount of work space.
-                  The software then reallocates more and more memory as
+                  The software reallocates memory as necessary.
-                  needed.
+                  The start value with MEMORY equal to 0 is 64 Megabytes,
-                  The starting value when MEMORY equals 0 is 64 Megabytes,
+                  the maximum is depends on -m option and the actual memory available.
-                  the maximum is given with memory of the -m option if used
-                  and the actual memory available.
 
  -f prefix      : defines the generic prefix of the files.
 
  -v verbose     : sets the output level parameter (the verbose parameter
                   must be in the range 0 to 10).
 
- -c component   : chooses the meshed component. If component is
+ -c component   : chooses the meshed component. If the parameter is
-                      0, all components to be meshed
+                      0, all components will be meshed, if
-                      1, only the main (outermost) component to be meshed
+                      1, only the main (outermost) component will be meshed
 
  -p0            : disables creation of internal points.
 
- -C             : uses alternate boundary recovery version. To be used only
+ -C             : uses an alternative boundary recovery mechanism. It should be used only
-                  when the boundary recovery of the standard version fails.
+                  when the standard boundary recovery fails.
 
  -E count       : sets the extended output for error messages. If -E is used,
-                  the error messages found will be printed, up to a maximum
+                  the error messages will be printed, it is possinle
-                  count of errors between 1 and 100.
+                  to indicate the maximum number of printed messages between 1 and 100.
 
  -t             : generates an error file prefix.Log
 
- -o level       : sets the desired optimisation level.
+ -o level       : sets the required optimisation level.
                   Valid optimisation levels are:
-                  none, light, medium or standard, strong,
+                  none, light, standard or strong,
-                  in increasing order of "quality vs speed" ratio.
+                  with increase of "quality vs speed" ratio.
 
  -I filetype    : defines the input mesh format as follows:
                     -IP input files are ascii files, named prefix.points
-                     and prefix.faces - this is the default
+                     and prefix.faces - this is the default type of files
                     -IPb input files are binary files, named prefix.pointsb
                      and prefix.facesb
                     -IM input file is ascii file, named prefix.mesh
-                  where prefix is given with the -f option
+                  where prefix is defined with -f option
 
  -a/-b          : selects the output file type:
                     -a for ascii (the default) and

doc/salome/gui/SMESH/input/group_of_underlying_elements.doc

@@ -0,0 +1,34 @@
+/*!
+
+\page group_of_underlying_elements_page "Create Group of Underlying Elements"
+
+
+To create groups of entities from existing groups of superior dimensions, in the \b Mesh menu select <b>Group of underlying entities</b>.<br>
+
+The following dialog box will appear:
+
+\image html dimgroup_dlg.png
+
+In this dialog box specify the name of the resulting group, types of entities and set of source groups.
+
+In the figure below, there are two source Volume groups:
+
+\image html dimgroup_src.png
+<center>Source groups</center>
+
+In this case the following results for Faces, Edges and Nodes are obtained: 
+
+\image html dimgroup_2d.png
+<center>Faces</center>
+
+\image html dimgroup_1d.png
+<center>Edges</center>
+
+\image html dimgroup_0d.png
+<center>Nodes</center>
+
+<b>See Also</b> a sample TUI Script of a 
+\ref tui_create_dim_group "Creating groups of entities from existing groups of superior dimensions"
+operation.
+
+*/

doc/salome/gui/SMESH/input/grouping_elements.doc

@@ -11,11 +11,22 @@ dialog.</li>
 <li> by creating a group of elements of the selected type from all
 such elements of the chosen geometrical object - <b>Group on
 geometry</b> tab of <b>Create group</b> dialog.</li>
+
+<li> by creating a group including all types of elements from an
+existing geometrical object - using subpage create_groups_from_geometry_page "Create Groups from Geometry" dialog.</li>
+
 <li> by creating several groups of elements (nodes,
 edges, faces and volumes) from the chosen submesh - using <b>Mesh -> Construct
-Group</b> Menu item. In this case groups of elements are created automatically.</li>
+Group</b> Menu item. In this case groups of elements are created
+automatically.</li>
+
+<li> by creating groups of entities from existing groups of superior
+dimensions - using subpage group_of_underlying_elements_page "Create Group of Underlying Elements"
+dialog.</li>
+
 </ul>
 
+
 The created groups can be later:
 
 <ul>

doc/salome/gui/SMESH/input/netgen_2d_3d_hypo.doc

@@ -36,7 +36,7 @@ create regular (possessing even sides) elements.</li>
 
 \image html netgen3d_simple.png
 
-<b>Netgen 2D simple parameters</b> and <b>Netgen 3D simple parameters</b> allow defining the size of elements for each dimension. Note that Netgen algorithm does not strictly follow the input parameters. The actual mesh can be more or less dense than required.<br>
+<b>Netgen 2D simple parameters</b> and <b>Netgen 3D simple parameters</b> allow defining the size of elements for each dimension. <br>
 
 \b 1D group allows defining the size of 1D elements in either of two ways: 
 <ul>
@@ -64,4 +64,15 @@ volumic elements will be equal to an average area of 2D elements, else </li>
 hypothesis.</li>
 <ul>
 
+\n Note that Netgen algorithm does not strictly follow the input
+parameters. The actual mesh can be more or less dense than required. There are several factors in it:
+<ol>
+<li> NETGEN does not actually use "NbOfSegments" parameter for discretization of
+edge. This parameter is used  only to define the local element size (size at the given point), so local sizes of adjacent edges influence each other. </li>
+<li> NETGEN additionally restricts the element size according to edge curvature.</li>
+<li> The local size of edges influences the size of close triangles.</li>
+<li> The order of elements and their size in the 1D mesh generated by
+NETGEN differ from those in the 1D mesh generated by Regular_1D
+algotithm, resulting in different 2D and 3D meshes.</li>
+</ol>
 */

doc/salome/gui/SMESH/input/revolution.doc

@@ -69,6 +69,7 @@ end point with respect to the coordinates of the start point;</li>
 <li>activate  <b>Generate Groups</b> checkbox to copy the groups of
 elements of the source mesh to the newly created one. </li>
 </li>
+</ul>
 
 <li>Click \b Apply or <b> Apply and Close</b> button to confirm the
 operation.</li>

doc/salome/gui/SMESH/input/symmetry.doc

@@ -22,8 +22,7 @@ It is possible to mirror a mesh or some of its elements through:
 
 </li>
 
-<li>
+<li>In the dialog:
-In the dialog:
 <ul>
 <li>specify the IDs of the elements for the symmetry operation:
 
@@ -74,7 +73,7 @@ name in the adjacent box);</li>
 <li>activate <b> Copy groups </b> checkbox to copy the groups of elements of the source mesh to the newly created mesh.</li>
 </ul>
 </li>
-
+</ul>
 <li>Click \b Apply or <b> Apply and Close</b> button to confirm the
 operation.</li>