X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fgui%2FSMESH%2Finput%2Fblsurf_hypo.doc;h=7e7a4f45a92a4a8dbf71ba92a553e311205d6aaa;hb=4994204921dc61e6731cb26f1e01b0225d43bf1b;hp=795fbb974a594ebdf9049720f982da84e52f1daa;hpb=91c92cb54310225231438b4d3bafeb0d1643a7c0;p=modules%2Fsmesh.git
diff --git a/doc/salome/gui/SMESH/input/blsurf_hypo.doc b/doc/salome/gui/SMESH/input/blsurf_hypo.doc
index 795fbb974..7e7a4f45a 100644
--- a/doc/salome/gui/SMESH/input/blsurf_hypo.doc
+++ b/doc/salome/gui/SMESH/input/blsurf_hypo.doc
@@ -2,9 +2,25 @@
\page blsurf_hypo_page BLSURF Parameters hypothesis
+\anchor blsurf_top
\n BLSURF Parameters hypothesis works only with BLSURF 2d
algorithm. This algorithm is a commercial software.
-
+\n To get a licence, visit http://www.distene.com/corp/eval-distene.html
+
+
+- \ref blsurf_general_parameters "General parameters"
+- \ref blsurf_advanced_parameters "Advanced parameters"
+- \ref blsurf_local_size "Local size"
+
+- \ref blsurf_sizemap_computation "Computation of the physical size"
+- \ref blsurf_attractor "Advanced maps"
+- \ref blsurf_attractor_computation "Computation of attractors"
+
+- \ref blsurf_enforced_elements "Enforced vertices"
+- \ref blsurf_limitations "Limitations"
+
+
+\anchor blsurf_general_parameters
General parameters
\image html blsurf_parameters.png
@@ -54,11 +70,21 @@ two adjacent edges.
Patch independent - if checked, geometrical
edges are not respected and all geometrical faces are meshed as one
hyper-face.
+
+\ref blsurf_top "Back to top"
+
+\anchor blsurf_advanced_parameters
Advanced parameters
+The notion of diag used in the descriptions means the diagonal of the bounding box of the
+geometrical object to mesh.
+
\image html blsurf_parameters_advanced.png
+Verbosity level - Defines the percentage of "verbosity" of
+BLSURF [0-100].
+
Topology - allows creation of a conform mesh on a shell of
not sewed faces.
@@ -67,37 +93,57 @@ not sewed faces.
- "Pre-process" and "Pre-process++" allow the BLSURF software to
pre-process the geometrical model to eventually produce a conform
mesh.
+ - "PreCAD" is an auxiliary CAD pre-processing module which has
+ two main goals:
+
+ - Complete missing or inadequate CAD descriptions.
+ - Perform topology reconstruction and specific geometry
+ enhancement for mesh generation.
+
+ This module requires a specific licence.
+ \n
+ The following PreCAD options are the most significant and important ones:
+
+ - Merge Edges - allows PreCAD to optimize the geometry by merging some
+ edges. This option is 0 by default.
+ - Remove nano edges - allows PreCAD to optimize the geometry by removing
+ the nano edges whenever possible. This option is 0 by default.
+ - Nano edge length - 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$.
+ - Discard input topology - computes the CAD topology from scratch,
+ without considering the toplogical information contained in the original CAD
+ (Useful for iges files). This option is 0 by default.
+
+
-Verbosity level - Defines the percentage of "verbosity" of
-BLSURF [0-100].
+ExportGMF - saves the computed mesh into a GMF file (.mesh or .meshb).
-Add option - provides the choice of multiple 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.
+Add option - 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.
-Clear option - removes the option selected in the table.
+Clear option - removes the option selected in the table.
\n
-The following options are commonly usable. The notion of diag
-used in the descriptions means
-the diagonal of the bounding box of the geometrical object to mesh.
+The following BLSURF options are commonly usable.
-- topo_eps1 (real) - is the tolerance level inside a CAD
-patch. By default is equal to diag � 10-4. This tolerance is used to
+
- \b topo_eps1 (real) - is the tolerance level inside a CAD
+patch. By default is equal to \f$\mathrm{diag} \times 10^{-4}\f$. This tolerance is used to
identify nodes to merge within one geometrical face when \b Topology
-option is to pre-process. Default is diag/10.0.
+option is to pre-process.
-- topo_eps2 (real) - is the tolerance level between two CAD
-patches. By default is equal to diag � 10-4. This tolerance is used to
+
- \b topo_eps2 (real) - is the tolerance level between two CAD
+patches. By default is equal to \f$\mathrm{diag} \times 10^{-4}\f$. This tolerance is used to
identify nodes to merge over different geometrical faces when
-\b Topology option is to pre-process. Default is diag/10.0.
+\b Topology option is to pre-process.
- \b LSS (real) - is an abbreviation for "length of sub-segment". It is
-a maximal allowed length of a mesh edge. Default is 0.5.
+a maximal allowed length of a mesh edge. Default is \f$0.5\f$.
- \b frontal (integer)
@@ -112,12 +158,11 @@ Default is 0.
interpolated value v between two points P1 and P2 on a
curve. Let h1 be the value at point P1, h2 be the value at point
P2, and t be a parameter varying from 0 to 1 when moving from P1
-to P2 .
+to P2.
-- 0 - the interpolation is linear: v = h1 + t (h2 - h1 )
-- 1 - the interpolation is geometric: v = h1 * pow( h2/h1, t)
-- 2 - the interpolation is sinusoidal: v = (h1+h2)/2 +
-(h1-h2)/2*cos(PI*t)
+- 0 - the interpolation is linear: \f$v = h1 + t (h2 - h1 )\f$
+- 1 - the interpolation is geometric: \f$v = h1 \times \left( \frac{h1}{h2} \right)^{t}\f$
+- 2 - the interpolation is sinusoidal: \f$v = \frac{h1+h2}{2} + \frac{h1-h2}{2 \cdot \cos(\pi \cdot t)}\f$
Default is 0.
@@ -125,7 +170,7 @@ Default is 0.
- \b hmean_flag (integer) - determines the computation of the average of several
values:
- -1 - the minimum is computed.
-- 0 or 2 - the arithmetic average computed.
+
- 0 or 2 - the arithmetic average is computed.
- 1 - the geometric average is computed.
Default is 0.
@@ -149,8 +194,8 @@ split into 20 edges. Default is 0.0.
- \b eps_ends (real) - is used to detect the curves whose lengths are very
small, which sometimes constitutes an error. A message is printed
-if fabs(P2-P1) < eps_ends, where P1 and P2 are the
-extremities of a curve. Default is diag/500.0.
+if \f$\left|P2-P1\right| < eps\_ends\f$, where P1 and P2 are the
+extremities of a curve. Default is \f$\frac{\mathrm{diag}}{500.0}\f$.
- \b prefix (char) - is a prefix of the files generated by
BLSURF. Default is "x".
@@ -159,12 +204,47 @@ BLSURF. Default is "x".
files. Default is 1.
+\n
+The following PreCAD options are commonly usable.
+
+- \b closed_geometry (int) - describes whether the working geometry
+should be closed or not. When activated, this option helps PreCAD to process
+the dirtiest geometries. By default this option is 0.
+- \b debug (int) - If debug = 1 PreCAD will be very verbose and will output
+some intermediate files in the working directory. By default this
+option is 0.
+- \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$.
+- \b eps_sewing (real) - tolerance of the assembly. It rarely requires to be tuned.
+By default this option is \f$\mathrm{diag} \times 5 \cdot 10^{-4}\f$.
+- \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$.
+- \b manifold_geometry (int) - describes whether the working geometry should be manifold or not.
+When activated, this option helps PreCAD to process the dirtiest
+geometries. By default this option is 0.
+- \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.
+- \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$.
+- \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$.
+- \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 created points and small edges. By default this
+option is \f$\mathrm{diag} \times 10^{-4}\f$.
+- \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$.
+
+
\n
The following advanced options are not documented and you can use them
at your own risk.
\n\n Integer variables:
- addsurf_ivertex
+- anisotropic
- background
- coiter
- communication
@@ -186,15 +266,16 @@ at your own risk.
Real variables:
-- addsurf_angle
-- addsurf_R
-- addsurf_H
-- addsurf_FG
-- addsurf_r
-- addsurf_PA
-- angle_compcurv
-- angle_ridge
-- eps_pardom
+- addsurf_angle
+- addsurf_R
+- addsurf_H
+- addsurf_FG
+- addsurf_r
+- addsurf_PA
+- angle_compcurv
+- angle_ridge
+- anisotropic_ratio
+- eps_pardom
String variables:
@@ -203,11 +284,12 @@ String variables:
- import_option
-Custom size map
+\ref blsurf_top "Back to top"
-\image html blsurf_parameters_sizemap1.png
+\anchor blsurf_local_size
+Local size
-User sizes can be defined on faces, edges or vertices.
+Local sizes can be defined on faces, edges or vertices.
- The faces, edges and vertices can belong to the meshed geometrical
object or to its sub-shapes (created using Explode command).
@@ -224,9 +306,19 @@ object or to its sub-shapes (created using Explode command).
+3 different types of size maps can be defined:
+
+- \ref blsurf_sizemap_computation "Computation of the physical size"
+- \ref blsurf_attractor "Advanced maps"
+- \ref blsurf_attractor_computation "Computation of attractors"
+
+
+\ref blsurf_top "Back to top"
+
\anchor blsurf_sizemap_computation
Computation of the physical size
-\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
@@ -239,6 +331,9 @@ specification of the sizes. The computation depends on whether point P is intern
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
Advanced maps
\n
@@ -272,14 +367,8 @@ BLSURF (gradation ...).
-\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
@@ -287,10 +376,14 @@ where such a hypothesis has been defined.
See Also 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
Computation of attractors
\n
-The size grows exponentially following the equation : h(d) = User size + (h_start - User Size) * exp( -(d / R)^2 ).
+The size grows exponentially following the equation :
+\f$h(d) = \mathrm{User Size} + (\mathrm{h\_start} - \mathrm{User Size}) \times e ^ { - \left( \frac{d}{R} \right) ^ {2} }\f$
\n
Where :
@@ -300,21 +393,38 @@ shape. The distance is the geodesic distance (i.e. calculated by following the s
- R is called the distance of influence and allows controlling the growth rate of the mesh
-Custom enforced vertices
+\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
+Enforced vertices
\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
+
+- selecting an existing Vertex or Compound,
+- or creating a new vertex given its coordinates.
+
+The enforced vertex is the projection of a point defined by its
+(x,y,z) coordinates on the selected face.
-- The enforced vertex is the projection of a point defined by its
-(x,y,z) coordinates on the selected face.
- It is possible to define several enforced vertices on a face or a group of faces.
- If the projected point is on the boundary or outside of the face, it will be ignored.
+- 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.
+You can specify BLSURF to use the internal vertices of the faces as enforced vertices by checking Use internal vertices of all faces.
+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.
+
See Also 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
Limitations
Currently BLSURF plugin has the following limitations.
@@ -333,4 +443,6 @@ Currently BLSURF plugin has the following limitations.
+\ref blsurf_top "Back to top"
+
*/