Salome HOME
Avoid empty items in the "Algorithm" combo-box in the "Create/Edit Mesh" dialog.
[modules/smesh.git] / doc / salome / gui / SMESH / input / blsurf_hypo.doc
index c5792322192df23ea22bedd91df44993cb8973a2..7e7a4f45a92a4a8dbf71ba92a553e311205d6aaa 100644 (file)
@@ -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 
@@ -77,8 +96,8 @@ not sewed faces.
   <li>"PreCAD" is an auxiliary CAD pre-processing module which has 
   two main goals:
   <ul>
-    <li> Complete missing or inadequate CAD-description.</li>
-    <li>Perform topology reconstruction and specific geometry 
+    <li> Complete missing or inadequate CAD descriptions.</li>
+    <li> Perform topology reconstruction and specific geometry 
     enhancement for mesh generation.</li>
   </ul>
   This module requires a specific licence.
@@ -86,15 +105,15 @@ not sewed faces.
   The following PreCAD options are the most significant and important ones:
   <ul>
   <li><b>Merge Edges</b> - allows PreCAD to optimize the geometry by merging some
-  edges. Default is 0.</li>
+  edges. This option is 0 by default.</li>
   <li><b>Remove nano edges</b> - allows PreCAD to optimize the geometry by removing 
-  the nano edges whenever possible. Default is 0.</li>
+  the nano edges whenever possible. This option is 0 by default.</li>
   <li><b>Nano edge length</b> - gives the length below which an edge is considered as nano 
   for the topology processing. See also the \b remove_nano_edges option. If unset, PreCAD
   default value is \f$\mathrm{diag} \times 10^{-5}\f$.</li>
   <li><b>Discard input topology</b> - computes the CAD topology from scratch, 
   without considering the toplogical information contained in the original CAD
-  (Useful for iges files). Default is 0.</li>
+  (Useful for iges files). This option is 0 by default.</li>
   </ul>
   </li>
 </ul>
@@ -103,8 +122,7 @@ not sewed faces.
 
 <li><b>Add option</b> - provides the choice of multiple PreCAD and BLSURF 
 advanced options, which appear, if selected, in a table where it is 
-possible to input the value of the option and to edit it later. The PreCAD 
-options are prefixed with "PRECAD_".</li>
+possible to input the value of the option and to edit it later.</li>
 
 <li><b>Clear option</b> - removes the option selected in the table.</li>
 
@@ -190,29 +208,34 @@ files. Default is 1.</li>
 The following PreCAD options are commonly usable. 
 <ul>
 <li>\b closed_geometry (int) - describes whether the working geometry 
-should be closed or not. When activated, this option helps PreCAD to treat 
-the most dirtiest geometries. Default is 0.</li>
+should be closed or not. When activated, this option helps PreCAD to process 
+the dirtiest geometries. By default this option is 0.</li>
 <li>\b debug (int) - If debug = 1 PreCAD will be very verbose and will output 
-some intermediate files in the working directory. Default is 0.</li>
-<li>\b eps_nano_relative (real) -  Same as \b eps_nano but given in relatively to 
-the diagonal of the box bounding the geometry. Default is \f$10^{-5}\f$.</li>
+some intermediate files in the working directory. By default this
+option is 0.</li>
+<li>\b eps_nano_relative (real) -  the same as \b eps_nano, but relatively to 
+the diagonal of the box bounding the geometry. By default this option is \f$10^{-5}\f$.</li>
 <li>\b eps_sewing (real) - tolerance of the assembly. It rarely requires to be tuned. 
-Default is \f$\mathrm{diag} \times 5 \cdot 10^{-4}\f$.</li>
-<li>\b eps_sewing_relative (real) -  Same as \b eps_nano but given in relatively to 
-the diagonal of the box bounding the geometry. Default is \f$5 \cdot 10^{-4}\f$.</li>
+By default this option is \f$\mathrm{diag} \times 5 \cdot 10^{-4}\f$.</li>
+<li>\b eps_sewing_relative (real) -  the same as \b eps_nano but relatively to 
+the diagonal of the box bounding the geometry. By default this option is \f$5 \cdot 10^{-4}\f$.</li>
 <li>\b manifold_geometry (int) - describes whether the working geometry should be manifold or not.
-When activated, this option helps PreCAD to treat the most dirtiest geometries. Default is 0.</li>
-<li>\b create_tag_collision (int) - creates some new tags from original ones in case 
-of collision (entity merge or association for example). Default is 0.</li>
-<li>\b periodic_tolerance (real) - defines the maximum distance error accepted between 
-two sets of periodic entities. Default is \f$\mathrm{diag} \times 10^{-5}\f$.</li>
-<li>\b periodic_tolerance_relative (real) -  Same as \b periodic_tolerance but in relative
-unit. Default is \f$10^{-5}\f$.</li>
-<li>\b periodic_split_tolerance (real) - This periodicity processing related option defines 
+When activated, this option helps PreCAD to process the dirtiest
+geometries. By default this option is 0.</li>
+<li>\b create_tag_collision (int) - creates new tags from original ones in case 
+of collision (entity merge or association for example). By default
+this option is 0.</li>
+<li>\b periodic_tolerance (real) - defines the maximum distance error accepted between 
+two sets of periodic entities. By default this option is \f$\mathrm{diag} \times 10^{-5}\f$.</li>
+<li>\b periodic_tolerance_relative (real) -  the same as \b
+periodic_tolerance but in a relative unit. Bu default this option is \f$10^{-5}\f$.</li>
+<li>\b periodic_split_tolerance (real) - This periodicity processing related option defines 
 the minimum distance between a CAD point and an imprinted point. It allows to indirectly 
-control the number of points and small edges created. Default is \f$\mathrm{diag} \times 10^{-4}\f$.</li>
-<li>\b periodic_split_tolerance_relative (real -  Same as \b periodic_split_tolerance but in
-relative unit. Default is \f$10^{-4}\f$.</li>
+control the number of created points and small edges. By default this
+option is \f$\mathrm{diag} \times 10^{-4}\f$.</li>
+<li>\b periodic_split_tolerance_relative (real -  the same as \b
+periodic_split_tolerance but in a relative unit. By default this
+option is \f$10^{-4}\f$.</li>
 </ul>
 
 \n
@@ -221,6 +244,7 @@ at your own risk.
 \n\n Integer variables:
 <ul>
 <li>    addsurf_ivertex</li>
+<li>    anisotropic    </li>
 <li>    background     </li>
 <li>    coiter         </li>
 <li>    communication  </li>
@@ -242,15 +266,16 @@ at your own risk.
 </ul>
 Real variables:
 <ul>
-<li>    addsurf_angle  </li>
-<li>    addsurf_R      </li>
-<li>    addsurf_H      </li>
-<li>    addsurf_FG     </li>
-<li>    addsurf_r      </li>
-<li>    addsurf_PA     </li>
-<li>    angle_compcurv </li>
-<li>    angle_ridge    </li>
-<li>    eps_pardom     </li>
+<li>    addsurf_angle    </li>
+<li>    addsurf_R        </li>
+<li>    addsurf_H        </li>
+<li>    addsurf_FG       </li>
+<li>    addsurf_r        </li>
+<li>    addsurf_PA       </li>
+<li>    angle_compcurv   </li>
+<li>    angle_ridge      </li>
+<li>    anisotropic_ratio</li>
+<li>    eps_pardom       </li>
 </ul>
 String variables:
 <ul>
@@ -259,11 +284,12 @@ String variables:
 <li>    import_option  </li>  
 </ul>
 
-<h1>Custom size map</h1>
+\ref blsurf_top "Back to top"
 
-\image html blsurf_parameters_sizemap1.png 
+\anchor blsurf_local_size
+<h1>Local size</h1>
 
-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>
@@ -280,9 +306,19 @@ object or to its sub-shapes (created using <b>Explode</b> command).</li>
 </ul></li>
 </ul>
 
+3 different types of size maps can be defined:
+<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>
+
+\ref blsurf_top "Back to top"
+
 \anchor blsurf_sizemap_computation
 <h2>Computation of the physical size</h2>
-\n
+\image html blsurf_parameters_sizemap1.png 
+
 The physical size is obtained by querying sizemap functions associated to the input CAD object for surfaces, curves and points.
 Each function can either return a value h (which is then trimmed
 between the two bounds hphymin and hphymax), or "no answer" (by not
@@ -295,6 +331,9 @@ 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_local_size "Back to \"Local size\"" \n
+\ref blsurf_top "Back to top"
+
 \anchor blsurf_attractor
 <h2>Advanced maps</h2>
 \n
@@ -328,14 +367,8 @@ BLSURF (gradation ...).</li>
 </ul>
 </ul>
 
-\image html blsurf_attractors2.png "Example of mesh created using
-attractors, the attractors here are the side edges and the size grows
-from the side of the surface towards the apex"
-\n
-\image html blsurf_const_size_near_shape2.png "Example of size map
-with constant size option, the size is kept constant on the left side
-of the surface until a certain distance"
-\n
+\image html blsurf_const_size_near_shape2.png "Example of size map with constant size option, the size is kept constant on the left side of the surface until a certain distance"
+
 Remark : The validation of the hypothesis might take a few seconds if
 attractors are defined or the "constant size" option is used because a
 map of distances has to be built on the whole surface for each face
@@ -343,6 +376,9 @@ 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_local_size "Back to \"Local size\"" \n
+\ref blsurf_top "Back to top"
+
 \anchor blsurf_attractor_computation
 <h2>Computation of attractors</h2>
 \n
@@ -357,21 +393,38 @@ 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>
+\image html blsurf_attractors2.png "Example of mesh created using attractors, the attractors here are the side edges and the size grows from the side of the surface towards the apex"
+
+\ref blsurf_local_size "Back to \"Local size\"" \n
+\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>
 
+You can specify BLSURF to use the internal vertices of the faces as enforced vertices by checking <i>Use internal vertices of all faces</i>.
+If a group name is specified, the internal enforced nodes will be added in the group. If the group does not exist it will be created.
+
 <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.
@@ -390,4 +443,6 @@ Currently BLSURF plugin has the following limitations.
   </li>
 </ul>
 
+\ref blsurf_top "Back to top"
+
 */