Salome HOME
Update SMESH documentation
[modules/smesh.git] / doc / salome / gui / SMESH / input / blsurf_hypo.doc
index b392f3b72d0dd9a841984ed6df9c299b8840da12..03c0fc5946a986bff218a70739defc427d09856d 100644 (file)
@@ -5,15 +5,21 @@
 \n BLSURF Parameters hypothesis works only with <b>BLSURF</b> 2d
 algorithm. This algorithm is a commercial software.
 
+<h1>General parameters</h1>
+
 \image html blsurf_parameters.png
 
 <ul>
 <li><b>Name</b> - allows defining the name of the hypothesis (BLSURF
 Parameters_n by default).</li>
 
-<li><b>Physical Mesh</b> - if set to "Custom", allows user input in te
+<li><b>Physical Mesh</b> - can be set to None, Custom or Size Map
+ <ul>
+  <li>if set to "Custom", allows user input in the
 in <b>User size</b>, <b>Max Physical Size</b> and <b>Min Physical
-Size</b> fields.
+Size</b> fields.</li>
+  <li>if set to "Size Map", behaves like "Custom" mode and takes into account the custom elements sizes given in the Size Map tab.</li>
+</ul>
 </li>
 
 <li><b>User size</b> - defines the size of the generated mesh elements. </li>
@@ -49,6 +55,8 @@ two adjacent edges. </li>
 edges are not respected and all geometrical faces are meshed as one
 hyper-face.</li>
 
+<h1>Advanced parameters</h1>
+
 \image html blsurf_parameters_advanced.png
 
 <li><b>Topology</b> - allows creation of a conform mesh on a shell of
@@ -79,12 +87,12 @@ the diagonal of the bounding box of the geometrical object to mesh.
 
 <ul>
 <li><b>topo_eps1</b> (real) - is the tolerance level inside a CAD
-patch. By default is equal to <i>diag</i> × 10-4. This tolerance is used to
+patch. By default is equal to <i>diag</i>  10-4. This tolerance is used to
 identify nodes to merge within one geometrical face when \b Topology
 option is to pre-process. Default is <i>diag</i>/10.0.</li>
 
 <li><b>topo_eps2</b> (real) - is the tolerance level between two CAD
-patches. By default is equal to <i>diag</i> × 10-4. This tolerance is used to
+patches. By default is equal to <i>diag</i>  10-4. This tolerance is used to
 identify nodes to merge over different geometrical faces when
 \b Topology option is to pre-process. Default is <i>diag</i>/10.0.</li>
 
@@ -99,6 +107,7 @@ slightly faster but generates less regular meshes. </li>
 </ul>
 Default is 0.</li>
 
+\anchor blsurf_hinterpol_flag
 <li>\b hinterpol_flag (integer) - determines the computation of an
 interpolated value <i>v</i> between two points <i>P1</i> and <i>P2</i> on a
 curve. Let <i>h1</i> be the value at point <i>P1,</i> <i>h2</i> be the value at point
@@ -112,6 +121,7 @@ to</i> <i>P2</i> .
 </ul>
 Default is 0.</li>
 
+\anchor blsurf_hmean_flag
 <li>\b hmean_flag (integer) - determines the computation of the average of several
 values:<ul>
 <li>-1 - the minimum is computed.</li>
@@ -152,7 +162,7 @@ files. Default is 1.</li>
 \n
 The following advanced options are not documented and you can use them
 at your own risk.
-\n\n Interger variables:
+\n\n Integer variables:
 <ul>
 <li>    addsurf_ivertex</li>
 <li>    background     </li>
@@ -193,8 +203,62 @@ String variables:
 <li>    import_option  </li>  
 </ul>
 
+<h1>Custom size map</h1>
+
+\image html blsurf_parameters_sizemap.png
+
+User 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>
+<li>Groups of faces, edges and vertices are also handled.</li>
+<li>It is possible to attribute the same size to several geometries using multi-selection.</li>
+<li>The sizes are constant values or python functions.</li>
+<li>In case of a python function, the following rules must be respected:
+<ul>
+<li>The name of the function is f.</li>
+<li>If geometry is a face or a group of faces, the function is f(u,v).</li>
+<li>If geometry is an edge or a group of edges, the function is f(t).</li>
+<li>If geometry is a vertex or a group of vertices, the function is f().</li>
+<li>The function must return a double.</li>
+</ul></li>
+</ul>
+
+<br><b>See Also</b> a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including size map.
 
+\anchor blsurf_sizemap_computation
+<h2>Computation of the physical size</h2>
 \n
+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
+assigning a value to h), thus providing great flexibility in the
+specification of the sizes. The computation depends on whether point P is internal to a surface, internal to a curve, or at the end of several curves:
+<ul>
+<li> If point P is internal to a surface, the CAD surface size function is queried. If no answer is returned, one interpolates with the values at the vertices of the discretized interface curves.</li>
+<li> If point P is internal to a curve, the CAD curve size function is queried first. If no answer is returned, the surface size function is queried for every adjacent surface and the mean value of the returned values is computed. If no answer is returned, sizes h1 and h2 at both ends of the curve are considered (see next item) and the interpolated value is computed.</li>
+<li> If point P is at the extremity of several curves, the CAD point size function is queried first. If no answer is returned, the curve size function is queried for every adjacent curve and the mean value of the returned values is computed. If no answer is returned, the surface size function is queried for every adjacent surface and the mean value of the returned values is computed. If there is still no answer returned, the default value hphydef is kept.</li>
+</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".
+
+
+<h1>Custom 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.
+<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>
+</ul>
+
+<br><b>See Also</b> a sample TUI Script of the \ref tui_blsurf "creation of a BLSurf hypothesis", including enforced vertices.
+
+<h1>Limitations</h1>
+
 Currently BLSURF plugin has the following limitations.
 <ul>
   <li>The created mesh will contain inverted elements if it is based on a shape,