Salome HOME
Avoid installing redundant files
[plugins/hexoticplugin.git] / doc / salome / gui / HexoticPLUGIN / input / hexotic_hypo.doc
index ab29eb8b07c3e7b4f763c8e87ac402fe4f73db4c..0901b1ed23766d442442dd87b695e957f103a6d2 100644 (file)
@@ -14,33 +14,30 @@ algorithm. This algorithm is a commercial software.
 <li><b>Name</b> - allows to define the name of the hypothesis (MG-Hexa 
 Parameters by default).</li>
 
-<li><b>Min size</b> - allows defining the minimal size of the elements (overrides <b>Nb. Hexes Max Level</b> value).</li>
+<li><b>Physical size</b> - defines size of elements
+  <ul>
+    <li><b>Type</b> - \a Global activates and \a None deactivates this option</li>
 
-<li><b>Max size</b> - allows defining the maximal size of the elements (overrides <b>Nb. Hexes Min Level</b> value).</li>
+    <li><b>Min size</b> - allows defining the minimal size of the elements (overrides <b>Nb. Hexes Max Level</b> value).</li>
 
-<li><b>Nb. Hexes Min Level</b> - allows defining the minimal level of recursive partitioning on the initial octree cube.</li>
-
-<li><b>Nb. Hexes Max Level</b> - allows defining the maximal level of recursive partitioning on the initial octree cube.</li>
-
-<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.
+    <li><b>Max size</b> - allows defining the maximal size of the
+    elements (overrides <b>Nb. Hexes Min Level</b> value).</li>
+  </ul>
 </li>
 
-<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.
-</li>
-
-<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.
-</li>
-
-<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).
-</li>
-
-<li><b>Working directory</b> - specifies the directory where the input/output files will be created.
-</li>
-
-<li><b>Verbosity</b> - specifies the verbose level to print information on meshing steps.
-</li>
-
-<li><b>Max memory (MB)</b> - specifies the maximum allocatable memory in MegaBytes.
+<li><b>Geometric size</b> - defines size of elements depending on curvature
+  <ul>
+    <li><b>Type</b> - \a Global activates and \a None deactivates this option</li>
+
+    <li><b>Mesh angle</b> - specifies the angle (in degrees) between two triangles
+    for the curvature based refinement. This angle should be in a
+    range between <b>ridge angle</b> and 180. This angle is a
+    threshold that will trigger the refinement: during the octree
+    building, each octant containing triangles that make an angle
+    greater than the threshold will be split. The process will be
+    repeated until every octants contain portion of the geometry
+    smoother than the threshold angle. </li>
+  </ul>
 </li>
 
 <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.
@@ -64,9 +61,78 @@ This allows to avoid the reconstruction of the GMF file from the SMESH structure
 
 In \b Advanced tab page you can specify advanced options of MG-Hexa not exposed in other pages.
 
+
 <b>Add option</b> adds a line to the table where you can type an option and its value as text.
 A check box in the first column activates/deactivates the option of the current row. A deactivated option will be erased upon pressing \a Ok.
 
+<ul>
+<li><b>Allow 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. </li>
+
+<li><b>Compute ridges</b> - Enables the computation of ridges. If set
+  to no, smooth meshes (without ridges) will be generated. 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.
+</li>
+
+<li><b>Element order</b> - determines the order of the mesh elements
+  to be generated: \a linear or \a quadratic</li>
+
+<li><b>Enforce constant layer size</b> - force the first physical layer to have the same size throughout the mesh.</li>
+
+<li><b>Flatten hexa sides</b> - activates specific optimization process to flatten the sides of hexahedra.</li>
+
+<li><b>Nb. Hexes Min Level</b> - allows defining the minimal level of recursive partitioning on the initial octree cube.</li>
+
+<li><b>Nb. Hexes Max Level</b> - allows defining the maximal level of recursive partitioning on the initial octree cube.</li>
+
+<li><b>Maximal memory (MB)</b> - specifies the maximum allocatable memory in MegaBytes.
+</li>
+
+<li><b>Maximal 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).
+</li>
+
+<li><b>Recover sharp angles</b> - subdivides elements around sharp angles up to <b>Nb. Hexes Max Level</b>.</li>
+
+<li><b>Ridge angle (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.
+</li>
+
+<li><b>Size map level</b> - when using a sizemap, sets the octree's
+  maximum subdivision level to apply to the sizemap.</li>
+
+<li><b>Tags</b> - sets how surface attributes must be considered. 
+  <ul>
+    <li>\a respect: preserve surface attributes </li>
+    <li>\a clear: clear surface attributes </li>
+  </ul>
+</li>
+
+<li><b>Working directory</b> - specifies the directory where the input/output files will be created.
+</li>
+
+<li><b>Verbosity</b> - specifies the verbose level to print information on meshing steps.
+</li>
+
+<li><b>Print log in a file</b> - if this option is checked on the log is printed in a 
+file placed in the working directory, otherwise it is printed on the standard output.
+</li>
+
+<li><b>Remove log on success</b> - if this option is checked on the log file is kept only
+if an error occurs during the computation. This option is only available if <b>Print log in a file</b>
+is enabled (there must be a log file to delete it) and <b>Keep all working files</b> is disabled 
+(in this case the log file is always kept). 
+</li>
+
+<li><b>Keep working files</b> - allows checking input and output files
+of MG-Hexa software, while usually these files are removed after the
+launch of the mesher. The log file (if any) is also kept if this option is checked.
+</li>
+</ul>
+
 \section hexotic_local_size_parameters Local size
 
 The local size allows you to drive locally the density of the 3D mesh.