Salome HOME
Merge from V6_main (04/10/2012)
[plugins/ghs3dplugin.git] / doc / salome / gui / GHS3DPLUGIN / input / ghs3d_hypo.doc
1 /*!
2
3 \page ghs3d_hypo_page GHS3D Parameters hypothesis
4
5 \anchor ghs3d_top
6 GHS3D Parameters hypothesis works only with <b>Tetrahedron (GHS3D)</b> 
7 algorithm. This algorithm is a commercial software.
8
9 To get a licence, visit http://www.distene.com/en/corp/eval-distene.html
10
11 \tableofcontents
12
13 \section ghs3d_general_parameters General parameters
14
15 \image html ghs3d_parameters_basic.png
16
17 - <b>Name</b> - allows to define the name of the hypothesis (GHS3D 
18 Parameters by default).
19
20 - <b>To mesh holes</b> - if checked, the algorithm will 
21 create mesh in the holes inside a solid shape, else only the outermost
22 shape will be meshed. Volumic elements created within holes are bound
23 to the solid.
24
25 - <b>Optimization level</b> - allows choosing the required
26 optimization level (higher level of optimisation provides better mesh,
27 but can be time-consuming):
28
29   - none
30
31   - light
32
33   - medium (standard)
34
35   - standard+
36
37   - strong
38
39 \ref ghs3d_top "Back to top"
40
41 \section ghs3d_advanced_parameters Advanced parameters
42
43 \image html ghs3d_parameters_advanced.png
44
45 - <b>Maximum memory size</b> - launches ghs3d software with
46 work space limited to the specified amount of RAM, in Mbytes. If this option is
47 checked off, the software will be launched with 7O% of the total RAM space.
48
49 - <b>Initial memory size</b> - starts ghs3d software with
50 the specified amount of work space, in Mbytes. If this option is checked off, the
51 software will be started with 100 Megabytes of working space.
52
53 - <b>Working directory</b> - allows defining the folder for input and output
54 files of ghs3d software, which are the files starting with "GHS3D_" prefix.
55
56 - <b>Keep working files</b> - allows checking input and output files
57 of ghs3d software, while usually these files are removed after the
58 launch of the mesher.
59
60 - <b>Verbose level</b> - to choose verbosity level in the range from
61 0 to 10.
62
63   - 0, no standard output,
64
65   - 2, prints the data, quality statistics of the skin and final
66   meshes and indicates when the final mesh is being saved. In addition
67   the software gives indication regarding the CPU time.
68
69   - 10, same as 2 plus the main steps in the computation, quality
70   statistics histogram of the skin mesh, quality statistics histogram
71   together with the characteristics of the final mesh.
72
73 - <b>To create new nodes</b> - if this option is checked off, ghs3d
74 tries to create tetrahedrons using only the nodes of the 2D mesh.
75
76 - <b>To remove the initial central point</b> TetMesh-GHS3D adds an internal point 
77 at the gravity centre of the bounding box to speed up and to simplify 
78 the meshing process. However, it is possible to refrain from creating 
79 this point by using the command line option -no initial central point. This can be
80 particularly useful to generate a volume mesh without internal points at all and in some rare cases
81 at the boundary regeneration phase when it is impossible to proceed
82 with the standard options
83 (for example, when one dimension of the domain is more than 20 times greater than the other two).
84 Use this option if the boundary regeneration has failed with the standard parameters and before using
85 the recovery version (command line option -C).
86 Note: when using this option, the speed of the meshing process may
87 decrease, and the quality may change.
88 Note: the boundary regeneration may fail with this option, in some rare cases.
89
90 - <b>To use boundary recovery version</b> - enables using a
91 boundary recovery module which tries to
92 create volume meshes starting from very poor quality surface meshes
93 (almost flat triangles on the surface, high density propagation,
94 extreme aspect ratios, etc.) which fails with the standard version. The
95 resulting volume mesh will however most likely have a very poor
96 quality (poor aspect ratio of elements, tetrahedra with a very small
97 positive volume).
98
99 - <b>To use FEM correction</b> - Applies finite-element correction by 
100 replacing overconstrained elements where it is possible. At first the process 
101 slices the overconstrained edges and at second the overconstrained 
102 facets. This ensures that there are no edges with two boundary
103 vertices and that there are no facets with three boundary vertices. TetMesh-GHS3D gives the initial 
104 and final overconstrained edges and facets. It also gives the facets
105 which have three edges on the boundary.
106 Note: when using this option, the speed of the meshing process may 
107 decrease, quality may change, and the smallest volume may be smaller.
108 By default, the FEM correction is not used.
109
110 - <b>Volumic gradation</b> - Defines the volumic ratio between 2 consecutive elements.
111 WARNING: Changing the default value of this parameter may dramatically decrease the quality of the resulting mesh.
112
113 - <b>Option as text</b> - allows to input in the command line any text
114 for ghs3d, for example, advanced options.
115
116 \ref ghs3d_top "Back to top"
117
118 \section ghs3d_enforced_vertices Enforced vertices
119
120 \note This feature is currently partially available only on meshes with no
121 geometry attached. Such meshes can be obtained by
122 - Copying an existing mesh
123 - Importing a mesh from file
124 - Applying a transformation to a mesh a get result in a new mesh
125 .
126 See below for more details.
127
128 \image html ghs3d_enforced_vertices.png
129
130 GHS3D algorithm can locally make the mesh finer. It is possible to
131 define enforced vertices in the volume where the mesh will be detailed.
132 A node will be created at the enforced vertex coordinates.
133
134 An enforced vertex is defined by:
135 - A vertex
136   - from GEOM (Vertex, Compound) - only avaible on meshes with no
137   geometry attached
138   - or from (x,y,z) cartesian coordinates
139 - A constant physical size
140 - If a group name is given, the created node will be added to the
141 group. If the group does not exist, it is created.
142
143 \ref ghs3d_top "Back to top"
144
145 \section ghs3d_enforced_meshes Enforced Meshes
146
147 \note This feature is currently only available on 2D meshes with no
148 geometry attached. Such meshes can be obtained by
149 - Copying an existing 2D mesh
150 - Importing a 2D mesh from file
151 - Applying a transformation to a 2D mesh a get result in a new mesh
152
153 \image html ghs3d_enforced_meshes.png
154
155 GHS3D algorithm can be forced by other meshes, sub-meshes or
156 groups. The constraint elements should be contained
157 entirely into the solid mesh.
158 - The constraint element types are:
159   - NODE
160   - EDGE
161   - FACE
162 - If a group name is given, the enforced elements will be added to
163 the group. If the group does not exist, it is created.
164
165 <br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a Ghs3D hypothesis", including enforced vertices and meshes.
166
167 \ref ghs3d_top "Back to top"
168
169 */