Salome HOME
Revert "Synchronize adm files"
[plugins/hexoticplugin.git] / doc / salome / gui / HexoticPLUGIN / input / hexotic_hypo.doc
1 /*!
2
3 \page hexotic_hypo_page Hexotic Parameters hypothesis
4
5 \n Hexotic Parameters hypothesis works only with <b>Hexotic</b> 
6 algorithm. This algorithm is a commercial software.
7 \n To get a licence, visit http://www.distene.com/en/corp/eval-distene.html
8
9 \section hexotic_general_parameters General parameters
10
11 \image html hexotic_parameters.png
12
13 <ul>
14 <li><b>Name</b> - allows to define the name of the hypothesis (Hexotic 
15 Parameters by default).</li>
16
17 <li><b>Min size</b> - allows defining the minimal size of the elements (overrides "Nb. Hexes Max Level" value).</li>
18
19 <li><b>Max size</b> - allows defining the maximal size of the elements (overrides "Nb. Hexes Min Level" value).</li>
20
21 <li><b>Nb. Hexes Min Level</b> - allows defining the minimal level of recursive partitioning on the initial octree cube.</li>
22
23 <li><b>Nb. Hexes Max Level</b> - allows defining the maximal level of recursive partitioning on the initial octree cube.</li>
24
25 <li><b>Generate smooth meshes no ridges</b> - specifies that the mesher can ignore ridges. A ridge is a geometrical entity (a sharp edge). The resulting meshes will have better quality elements, at the price of "smoothing" out the geometry.
26 </li>
27
28 <li><b>Authorize invalid elements</b> - specifies that the mesher must conform as much as possible to the geometry (especially the sharp edges). The resulting meshes may contain invalid elements (but with positive volumes: for example, three vertices of an hexahedron on the same edge), for the benefit of better geometry accuracy.
29 </li>
30
31 <li><b>Sharp angle threshold in degrees</b> - specifies the angle between two triangles above which the hex mesher will consider the edge common to these two triangles as being a "ridge". A ridge is a geometrical entity (a sharp edge) which has to be kept as it is in the final hex mesh.The default value is 60 (degrees).<br>If you raise this value, the hex mesher will detect less ridges, and the final solid mesh will therefore be smoother. On the other hand, if you reduce this value, more ridges will be detected and the algorithm will face harder situations to conform to.
32 </li>
33
34 <li><b>Number of threads</b> - specifies the number of threads to be used (this should be the number of cores or processors of a shared memory parallel architecture).
35 </li>
36
37 <li><b>Working directory</b> - specifies the directory where the input/output files will be created.
38 </li>
39
40 <li><b>Verbosity</b> - specifies the verbose level to print information on meshing steps.
41 </li>
42
43 <li><b>Max memory (MB)</b> - specifies the maximum allocatable memory in MegaBytes.
44 </li>
45
46 <li><b>Sub-domains mesh mode</b> - This option allows the user to mesh or not mesh internal subdomains (such as holes), or to mesh non-manifold domains.
47 <ul>
48 <li>sd 1 : meshes in inside/out mode: the internal cavities are ignored, the whole domain is meshed into a single domain;</li>
49 <li>sd 2 : meshes only the internal main component. Internal holes (cavities) will not be meshed;</li>
50 <li>sd 3 : meshes all cavities and generates subdomains accordingly;</li>
51 <li>sd 4 : meshes non-manifold geometries as such and generates subdomains accordingly.</li>
52 </ul>
53 </li>
54 </ul>
55
56 \note If BLSURF is used as 2D algo, and if a GMF file is defined as output file (using SetGMFFile(my2Dmesh.mesh)), then Hexotic will use this file as input.
57 This allows to avoid the reconstruction of the GMF file from the SMESH structure and can improve the global computation time.
58
59 <br><b>See Also</b> a sample TUI Script of the \ref tui_hexotic "creation of an Hexotic mesh"
60
61 \section hexotic_local_size_parameters Local size
62
63 The local size allows you to drive locally the density of the 3D mesh. 
64 The area where the mesh has to be refined is given as a geometrical shape.
65
66 \image html hexotic_local_size_parameters.png
67  
68 <ul>
69 <li><b>Selection field (Shape)</b> - Area where the hexaedral mesh has to be refined. You can select any kind of shape (vertex, edge, face, solid, ...). The shape can be a subshape of the main shape or not.</li>
70 <li><b>Local size</b> - Expected size of the hexahedral mesh in (Solid) or near the given shape</li>
71 <li><b>Add button</b> - Add the local size to the list of local sizes (showed on the left)</li>
72 <li><b>Remove button</b> - Remove a local size frome the list, select the local size in the list and press <i>Remove</i> </li>
73 </ul>
74
75 \note The local size will only influence the density towards a locally denser mesh. If the required density is coarser than the one determined automatically by the global size parameters 
76 (min size, max size, min level, max level), it will be ignored and the default density will be used.
77 */