Update BLSURFPLUGIN and GHS3DPLUGIN documentations

doc/salome/gui/SMESH/input/blsurf_hypo.doc

@@ -2,10 +2,25 @@
 
 \page blsurf_hypo_page BLSURF Parameters hypothesis
 
+\anchor blsurf_top
 \n BLSURF Parameters hypothesis works only with <b>BLSURF</b> 2d
 algorithm. This algorithm is a commercial software.
 \n To get a licence, visit http://www.distene.com/corp/eval-distene.html
 
+<ol>
+<li>\ref blsurf_general_parameters "General parameters"</li>
+<li>\ref blsurf_advanced_parameters "Advanced parameters"</li>
+<li>\ref blsurf_local_size "Local size"</li>
+<ol>
+<li type="a">\ref blsurf_sizemap_computation "Computation of the physical size"</li>
+<li type="a">\ref blsurf_attractor "Advanced maps"</li>
+<li type="a">\ref blsurf_attractor_computation "Computation of attractors"</li>
+</ol>
+<li>\ref blsurf_enforced_elements "Enforced vertices"</li>
+<li>\ref blsurf_limitations "Limitations"</li>
+</ol>
+
+\anchor blsurf_general_parameters
 <h1>General parameters</h1>
 
 \image html blsurf_parameters.png
@@ -55,7 +70,11 @@ two adjacent edges. </li>
 <li><b>Patch independent</b> - if checked, geometrical
 edges are not respected and all geometrical faces are meshed as one
 hyper-face.</li>
+</ul>
 
+\ref blsurf_top "Back to top"
+
+\anchor blsurf_advanced_parameters
 <h1>Advanced parameters</h1>
 
 The notion of <i>diag</i> used in the descriptions means the diagonal of the bounding box of the 
@@ -258,11 +277,14 @@ String variables:
 <li>    import_option  </li>  
 </ul>
 
-<h1>Custom size map</h1>
+\ref blsurf_top "Back to top"
+
+\anchor blsurf_local_size
+<h1>Local size</h1>
 
 \image html blsurf_parameters_sizemap1.png 
 
-User sizes can be defined on faces, edges or vertices.
+Local sizes can be defined on faces, edges or vertices.
 <ul>
 <li>The faces, edges and vertices can belong to the meshed geometrical
 object or to its sub-shapes (created using <b>Explode</b> command).</li>
@@ -279,6 +301,8 @@ object or to its sub-shapes (created using <b>Explode</b> command).</li>
 </ul></li>
 </ul>
 
+\ref blsurf_top "Back to top"
+
 \anchor blsurf_sizemap_computation
 <h2>Computation of the physical size</h2>
 \n
@@ -294,6 +318,8 @@ specification of the sizes. The computation depends on whether point P is intern
 </ul>
 In order to compute the mean of several values, the arithmetic mean is used by default, but this can be modified by the parameter \ref blsurf_hmean_flag "hmean flag". In the same way, in order to interpolate two values, a linear interpolation is used by default, but this can be modified by \ref blsurf_hinterpol_flag "hinterpol flag".
 
+\ref blsurf_top "Back to top"
+
 \anchor blsurf_attractor
 <h2>Advanced maps</h2>
 \n
@@ -342,6 +368,8 @@ where such a hypothesis has been defined.
 
 <br><b>See Also</b> a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including size map.
 
+\ref blsurf_top "Back to top"
+
 \anchor blsurf_attractor_computation
 <h2>Computation of attractors</h2>
 \n
@@ -356,21 +384,32 @@ shape. The distance is the geodesic distance (i.e. calculated by following the s
 <li>R is called the distance of influence and allows controlling the growth rate of the mesh </li>
 </ul>
 
-<h1>Custom enforced vertices</h1>
+\ref blsurf_top "Back to top"
+
+\anchor blsurf_enforced_elements
+<h1>Enforced vertices</h1>
 
 \image html blsurf_parameters_enforced_vertices.png
 
-It is possible to define some enforced vertices to BLSurf algorithm
-without creating any vertices by CAD algorithms.
+It is possible to define some enforced vertices to BLSurf algorithm.
+An enforced vertex is defined on a Face or a Compound by
+<ul>
+<li> selecting an existing Vertex or Compound,</li>
+<li> or creating a new vertex given its coordinates.</li>
+</ul>
+The enforced vertex is the projection of a point defined by its
+(x,y,z) coordinates on the selected face.
 <ul>
-<li>The enforced vertex is the projection of a point defined by its
-(x,y,z) coordinates on the selected face.</li>
 <li>It is possible to define several enforced vertices on a face or a group of faces.</li>
 <li>If the projected point is on the boundary or outside of the face, it will be ignored.</li>
+<li>If a group name is specified, the enforced nodes will be added in the group. If the group does not exist it will be created.
 </ul>
 
 <br><b>See Also</b> a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including enforced vertices.
 
+\ref blsurf_top "Back to top"
+
+\anchor blsurf_limitations
 <h1>Limitations</h1>
 
 Currently BLSURF plugin has the following limitations.
@@ -389,4 +428,6 @@ Currently BLSURF plugin has the following limitations.
   </li>
 </ul>
 
+\ref blsurf_top "Back to top"
+
 */

doc/salome/gui/SMESH/input/ghs3d_hypo.doc

@@ -2,10 +2,19 @@
 
 \page ghs3d_hypo_page GHS3D Parameters hypothesis
 
+\anchor ghs3d_top
 \n GHS3D Parameters hypothesis works only with <b>Tetrahedron (GHS3D)</b> 
 algorithm. This algorithm is a commercial software.
 \n To get a licence, visit http://www.distene.com/corp/eval-distene.html
 
+<ol>
+<li>\ref ghs3d_general_parameters "General parameters"</li>
+<li>\ref ghs3d_advanced_parameters "Advanced parameters"</li>
+<li>\ref ghs3d_enforced_vertices "Enforced vertices"</li>
+<li>\ref ghs3d_enforced_meshes "Enforced meshes"</li>
+</ol>
+
+\anchor ghs3d_general_parameters
 <h1>General parameters</h1>
 
 \image html ghs3d_parameters_basic.png
@@ -20,10 +29,22 @@ shape will be meshed. Volumic elements created within holes are bound
 to the solid.</li>
 
 <li><b>Optimization level</b> - allows choosing the required
-optimization level: none, light, medium or strong. Higher level of
+optimization level: 
+<ul>
+<li>none,</li>
+<li>light,</li>
+<li>medium (standard),</li>
+<li>standard+,</li>
+<li>strong.</li>
+</ul>
+Higher level of
 optimisation provides better mesh, but can be time-consuming.
 </li>
+</ul>
 
+\ref ghs3d_top "Back to top"
+
+\anchor ghs3d_advanced_parameters
 <h1>Advanced parameters</h1>
 
 \image html ghs3d_parameters_advanced.png
@@ -96,22 +117,63 @@ for ghs3d, for example, advanced options. </li>
 
 </ul>
 
+\ref ghs3d_top "Back to top"
 
+\anchor ghs3d_enforced_vertices
 <h1>Enforced vertices</h1>
 
+\note This feature is currently only available on meshes with no geometry attached. Such meshes can be obtained by
+<ul>
+<li>Copying an existing mesh</li>
+<li>Importing a mesh from file</li>
+<li>Applying a transformation to a mesh a get result in a new mesh</li>
+</ul>
+
 \image html ghs3d_enforced_vertices.png
 
 GHS3D algorithm can locally make the mesh finer. It is possible to define enforced vertices in the volume where the mesh will be detailed.
-
-A node will be created at the enforced vertex coordinates. There is no need to create a vertex in CAD.
+A node will be created at the enforced vertex coordinates.
 
 An enforced vertex is defined by:
 <ul>
-<li>The (x,y,z) cartesian coordinates</li>
+<li>A vertex</li>
+<ul>
+<li>from GEOM (Vertex, Compound)</li>
+<li>or from (x,y,z) cartesian coordinates</li>
+</ul>
 <li>A constant physical size</li>
+<li>If a group name is given, the created node will be added to the group. If the group does not exist, it is created.</li>
+</ul>
+\ref ghs3d_top "Back to top"
+
+\anchor ghs3d_enforced_meshes
+<h1>Enforced Meshes</h1>
+
+\note This feature is currently only available on meshes with no geometry attached. Such meshes can be obtained by
+<ul>
+<li>Copying an existing mesh</li>
+<li>Importing a mesh from file</li>
+<li>Applying a transformation to a mesh a get result in a new mesh</li>
+</ul>
+
+\image html ghs3d_enforced_meshes.png
+
+GHS3D algorithm can be forced by other meshes, sub-meshes or groups. The constraint elements should be contained
+entirely into the solid meshed.
+<ul>
+<li>The constraint element types are:
+<ul>
+<li>NODE</li>
+<li>EDGE</li>
+<li>FACE</li>
+</ul></li>
+<li>If a size is given, the meshe will be refined around the enforced elements given the size</li>
+<li>If a group name is given, the enforced elements will be added to the group. If the group does not exist, it is created.</li>
 </ul>
 
 <br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a Ghs3D hypothesis", including enforced vertices.
 
+\ref ghs3d_top "Back to top"
+
 
 */

doc/salome/gui/SMESH/input/tui_defining_ghs3d_hypotheses.doc

@@ -3,6 +3,14 @@
 \page tui_defining_ghs3d_hypotheses_page Defining Hypotheses for Ghs3D Algorithm
 
 \anchor tui_ghs3d
+
+<ol>
+<li>\ref tui_ghs3d_basic "Construction of Mesh using Ghs3D algorithm"</li>
+<li>\ref tui_ghs3d_enforced_vertices "Adding enforced vertices"</li>
+<li>\ref tui_ghs3d_enforced_meshes "Adding enforced mesh"</li>
+</ol>
+
+\anchor tui_ghs3d_basic
 <h2>Construction of Mesh using Ghs3D algorithm</h2>
 
 \code
@@ -30,6 +38,9 @@ ghs3dMesh.Compute()
 
 \image html ghs3d_screenshot.png Ghs3d mesh withtout hypothesis
 
+\ref tui_ghs3d "Back to top"
+
+\anchor tui_ghs3d_enforced_vertices
 <h2>Adding enforced vertices</h2>
 
 \code
@@ -100,6 +111,9 @@ GHS3D_Parameters.ClearEnforcedVertices()
 \image html ghs3d_screenshot_enf1.png Ghs3d mesh with enforced vertex
 \image html ghs3d_screenshot_enf2.png Ghs3d mesh with enforced vertex from GEOM vertex
 
+\ref tui_ghs3d "Back to top"
+
+\anchor tui_ghs3d_enforced_meshes
 <h2>Adding enforced mesh</h2>
 
 \code
@@ -156,7 +170,7 @@ GHS3D_Parameters_mesh.SetToMeshHoles( 1 ) # to mesh inside the cylinder
 
 # Create the mesh on the cylinder
 Mesh_cylindre = smesh.Mesh(cylindre)
-SetName(Mesh_cylindre,"Mesh_cylindre")
+smesh.SetName(Mesh_cylindre,"Mesh_cylindre")
 Mesh_cylindre.AddHypothesis( BLSURF )
 Mesh_cylindre.AddHypothesis( BLSURF_Parameters2 )
 # Create some groups
@@ -213,4 +227,6 @@ mesh_mesh.Compute()
 \image html ghs3d_screenshot_enf5.png
 \image html ghs3d_screenshot_enf6.png
 
+\ref tui_ghs3d "Back to top"
+
 */