Salome HOME
add more options to BLSURF
[modules/smesh.git] / doc / salome / gui / SMESH / input / blsurf_hypo.doc
1 /*!
2
3 \page blsurf_hypo_page BLSURF Parameters hypothesis
4
5 \n BLSURF Parameters hypothesis works only with <b>BLSURF</b> 2d
6 algorithm. This algorithm is a commercial software.
7
8 \image html blsurf_parameters.png
9
10 <ul>
11 <li><b>Name</b> - allows to define the name of the hypothesis (BLSURF
12 Parameters by default).</li>
13
14 <li><b>Physical Mesh</b> - if is set to "Custom", allows to set size
15 of mesh elements to generate in <b>User size</b> field.
16 </li>
17
18 <li><b>User size</b> - size of mesh elements to generate. </li>
19
20 <li><b>Max Physical Size</b> - is an upper limit of mesh element size. </li>
21
22 <li><b>Min Physical Size</b> - is a lower limit of mesh element size. </li>
23
24 <li><b>Geometrical mesh</b> - if is set to "Custom", allows to set
25 mesh element deflection from curves and surfaces and element
26 size change rate in <b>Angle Mesh S</b>, <b>Angle Mesh C</b> and
27 <b>Gradation</b> fields correspondingly. These fields control
28 computation of element size, so called <i>geometrical size</i>, conform to
29 the surface geometry considering local curvatures. \n
30 The eventual element size at each point will be minimum of <b>User
31 size</b>, if given, and the <i>geometrical size</i>. </li>
32
33 <li><b>Angle Mesh S</b> - maximal allowed angle in degrees at a mesh
34 node between the mesh face and the tangent to the geometrical surface. </li>
35
36 <li><b>Angle Mesh C</b> - maximal allowed angle in degrees at a mesh
37 node between the mesh edge and the tangent to the geometrical curve. </li>
38
39 <li><b>Max Geometrical Size</b> - is an upper limit of <i>geometrical size</i>.</li>
40
41 <li><b>Min Geometrical Size</b> - is a lower limit of <i>geometrical size</i>.</li>
42
43 <li><b>Gradation</b> - maximal allowed ratio between the lengths of
44 two adjacent edges. </li>
45
46 <li><b>Allow Quadrangles</b> - to create quadrilateral elements.</li>
47
48 <li><b>Patch independent</b> - if this box is checked on, geometrical
49 edges are not respected and all geometrical faces are meshed as one
50 hyper-face.</li>
51
52 \image html blsurf_parameters_advanced.png
53
54 <li><b>Topology</b> - allows creation of a conform mesh on a shell of
55 not sewed faces. 
56 <ul>
57   <li>"From CAD" means that mesh conformity is assured by conformity
58   of a shape.</li>
59   <li>"Pre-process" and "Pre-process++" let BLSURF software
60   pre-process the geometrical model to eventually produce a conform
61   mesh. </li>
62 </ul>
63
64 <li><b>Verbosity level</b> - Defines the percentage of "verbosity" of
65 BLSURF [0-100].</li>
66
67 <li><b>Add option</b> - provides a choice of multiple advanced
68 options, each of which, if selected, appear in a table where you can
69 enter a value of the option and edit it later.</li>
70
71 <li><b>Clear option</b> - removes option selected in the table.
72
73 </ul>
74
75 Commonly usable options are following. The name <i>diag</i> stands there for
76 the diagonal of the bounding box of the geometrical object to mesh.
77
78 <ul>
79 <li><b>topo_eps1</b> (real) - is the tolerance level inside a CAD
80 patch. By default is equal to <i>diag</i> × 10-4. This tolerance is used to
81 identify nodes to merge within one geometrical face when \b Topology
82 option is to pre-process. Default is <i>diag</i>/10.0.</li>
83
84 <li><b>topo_eps2</b> (real) - is the tolerance level between two CAD
85 patches. By default is equal to <i>diag</i> × 10-4. This tolerance is used to
86 identify nodes to merge over different geometrical faces when
87 \b Topology option is to pre-process. Default is <i>diag</i>/10.0.</li>
88
89 <li>\b LSS (real) - is an abbreviation for "length of sub-segment". It is
90 a maximal allowed length of a mesh edge. Default is 0.5.</li>
91
92 <li>\b frontal (integer)
93 <ul>
94 <li> 1 - the mesh generator inserts points with an advancing front method.</li>
95 <li> 0 - it inserts them with an algebraic method (on internal edges). This method is
96 slightly faster but generates less regular meshes. </li>
97 </ul>
98 Default is 0.</li>
99
100 <li>\b hinterpol_flag (integer) - determines the computation of an
101 interpolated value <i>v</i> between two points <i>P1</i> and <i>P2</i> on a
102 curve. Let <i>h1</i> be the value at point <i>P1,</i> <i>h2</i> be the value at point
103 <i>P2,</i> and <i>t</i> be a parameter varying from 0 to 1 when moving from <i>P1
104 to</i> <i>P2</i> . 
105 <ul>
106 <li>0 - the interpolation is linear: <i>v = h1 + t (h2 - h1 )</i></li>
107 <li>1 - the interpolation is geometric: <i>v = h1 * pow( h2/h1, t)</i></li>
108 <li>2 - the interpolation is sinusoidal: <i>v = (h1+h2)/2 +
109 (h1-h2)/2*cos(PI*t)</i></li>
110 </ul>
111 Default is 0.</li>
112
113 <li>\b hmean_flag (integer) - determines the computation of the mean of several
114 values:<ul>
115 <li>-1 - the minimum is computed.</li>
116 <li>0 or 2 - the arithmetic mean computed.
117 <li>1 - the geometric mean is computed.</li>
118 </ul>
119 Default is 0.</li>
120
121 <li>\b CheckAdjacentEdges, \b CheckCloseEdges and \b CheckWellDefined
122 (integers) - give number of calls of equally named subroutines the
123 purpose of which is to improve the mesh of domains having narrow
124 parts. At each iteration,\b CheckCloseEdges decreases the sizes of the
125 edges when two boundary curves are neighboring,\b CheckAdjacentEdges
126 balances the sizes of adjacent edges, and \b CheckWellDefined checks if
127 the parametric domain is well defined. Default values are 0.</li>
128
129
130 <li>\b CoefRectangle (real)- defines the relative thickness of the rectangles
131 used by subroutine \b CheckCloseEdges (see above). Default is 0.25.</li>
132
133 <li>\b eps_collapse (real) - if is more than 0.0, BLSURF removes
134 curves whose lengths are less than \b eps_collapse. Here, to obtain an
135 approximate value of the length of a curve, the latter is arbitrarily
136 split into 20 edges. Default is 0.0.</li>
137
138 <li>\b eps_ends (real) - is used to detect curves whose lengths are very
139 small, which sometimes constitutes an error. A message is printed
140 if<i> fabs(P2-P1) < eps_ends</i>, where </i>P1 and </i>P2 are the
141 extremities of a curve. Default is <i>diag</i>/500.0.
142
143 <li>\b prefix (char) - is a prefix of the files generated by BLSURF. Default is "x".</li>
144
145 <li>\b refs (integer) - reference of a surface, used when exporting
146 files. Default is 1.</li>
147
148 </ul>
149 */