doc/salome/gui/HexoticPLUGIN/input/hexotic_hypo.doc

   1 /*!
   2
   3 \page hexotic_hypo_page MG-Hexa Parameters hypothesis
   4
   5 \n MG-Hexa Parameters hypothesis works only with <b>MG-Hexa</b>
   6 algorithm. This algorithm is a commercial software.
   7 \n To get a license, visit http://www.meshgems.com/meshgems-products.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 (MG-Hexa
  15 Parameters by default).</li>
  16
  17 <li><b>Physical size</b> - defines size of elements
  18   <ul>
  19     <li><b>Type</b> - \a Global activates and \a None deactivates this option</li>
  20
  21     <li><b>Min size</b> - allows defining the minimal size of the elements (overrides <b>Nb. Hexes Max Level</b> value).</li>
  22
  23     <li><b>Max size</b> - allows defining the maximal size of the
  24     elements (overrides <b>Nb. Hexes Min Level</b> value).</li>
  25   </ul>
  26 </li>
  27
  28 <li><b>Geometric size</b> - defines size of elements depending on curvature
  29   <ul>
  30     <li><b>Type</b> - \a Global activates and \a None deactivates this option</li>
  31
  32     <li><b>Mesh angle</b> - specifies the angle (in degrees) between two triangles
  33     for the curvature based refinement. This angle should be in a
  34     range between <b>ridge angle</b> and 180. This angle is a
  35     threshold that will trigger the refinement: during the octree
  36     building, each octant containing triangles that make an angle
  37     greater than the threshold will be split. The process will be
  38     repeated until every octants contain portion of the geometry
  39     smoother than the threshold angle. </li>
  40   </ul>
  41 </li>
  42
  43 <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.
  44 <ul>
  45 <li>sd 1 : meshes in inside/out mode: the internal cavities are ignored, the whole domain is meshed into a single domain;</li>
  46 <li>sd 2 : meshes only the internal main component. Internal holes (cavities) will not be meshed;</li>
  47 <li>sd 3 : meshes all cavities and generates subdomains accordingly;</li>
  48 <li>sd 4 : meshes non-manifold geometries as such and generates subdomains accordingly.</li>
  49 </ul>
  50 </li>
  51 </ul>
  52
  53 \note If MG-CADSurf is used as 2D algo, and if a GMF file is defined as output file (using SetGMFFile(my2Dmesh.mesh)), then MG-Hexa will use this file as input.
  54 This allows to avoid the reconstruction of the GMF file from the SMESH structure and can improve the global computation time.
  55
  56 <br><b>See Also</b> a sample TUI Script of the \ref tui_hexotic "creation of a MG-Hexa mesh"
  57
  58 \section hexotic_adv_options Advanced parameters
  59
  60 \image html hexotic_advanced_options.png
  61
  62 In \b Advanced tab page you can specify advanced options of MG-Hexa not exposed in other pages.
  63
  64
  65 <b>Add option</b> adds a line to the table where you can type an option and its value as text.
  66 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.
  67
  68 <ul>
  69 <li><b>Allow invalid elements</b> - specifies that the mesher must
  70   conform as much as possible to the geometry (especially the sharp
  71   edges). The resulting meshes may contain invalid elements (but with
  72   positive volumes: for example, three vertices of an hexahedron on
  73   the same edge), for the benefit of better geometry accuracy. </li>
  74
  75 <li><b>Compute ridges</b> - Enables the computation of ridges. If set
  76   to no, smooth meshes (without ridges) will be generated. A ridge is
  77   a geometrical entity (a sharp edge). The resulting meshes will have
  78   better quality elements, at the price of "smoothing" out the
  79   geometry.
  80 </li>
  81
  82 <li><b>Element order</b> - determines the order of the mesh elements
  83   to be generated: \a linear or \a quadratic</li>
  84
  85 <li><b>Enforce constant layer size</b> - force the first physical layer to have the same size throughout the mesh.</li>
  86
  87 <li><b>Flatten hexa sides</b> - activates specific optimization process to flatten the sides of hexahedra.</li>
  88
  89 <li><b>Nb. Hexes Min Level</b> - allows defining the minimal level of recursive partitioning on the initial octree cube.</li>
  90
  91 <li><b>Nb. Hexes Max Level</b> - allows defining the maximal level of recursive partitioning on the initial octree cube.</li>
  92
  93 <li><b>Maximal memory (MB)</b> - specifies the maximum allocatable memory in MegaBytes.
  94 </li>
  95
  96 <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).
  97 </li>
  98
  99 <li><b>Recover sharp angles</b> - subdivides elements around sharp angles up to <b>Nb. Hexes Max Level</b>.</li>
 100
 101 <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.
 102 </li>
 103
 104 <li><b>Size map level</b> - when using a sizemap, sets the octree's
 105   maximum subdivision level to apply to the sizemap.</li>
 106
 107 <li><b>Tags</b> - sets how surface attributes must be considered.
 108   <ul>
 109     <li>\a respect: preserve surface attributes </li>
 110     <li>\a clear: clear surface attributes </li>
 111   </ul>
 112 </li>
 113
 114 <li><b>Working directory</b> - specifies the directory where the input/output files will be created.
 115 </li>
 116
 117 <li><b>Verbosity</b> - specifies the verbose level to print information on meshing steps.
 118 </li>
 119
 120 <li><b>Print log in a file</b> - if this option is checked on the log is printed in a
 121 file placed in the working directory, otherwise it is printed on the standard output.
 122 </li>
 123
 124 <li><b>Remove log on success</b> - if this option is checked on the log file is kept only
 125 if an error occurs during the computation. This option is only available if <b>Print log in a file</b>
 126 is enabled (there must be a log file to delete it) and <b>Keep all working files</b> is disabled
 127 (in this case the log file is always kept).
 128 </li>
 129
 130 <li><b>Keep working files</b> - allows checking input and output files
 131 of MG-Hexa software, while usually these files are removed after the
 132 launch of the mesher. The log file (if any) is also kept if this option is checked.
 133 </li>
 134 </ul>
 135
 136 \section hexotic_local_size_parameters Local size
 137
 138 The local size allows you to drive locally the density of the 3D mesh.
 139 The area where the mesh has to be refined is given as a geometrical shape.
 140
 141 \image html hexotic_local_size_parameters.png
 142
 143 <ul>
 144 <li><b>Selection field (Shape)</b> - Area where the hexahedral mesh has to be refined. You can select any kind of shape (vertex, edge, face, solid, ...). The shape can be a sub-shape of the main shape or not.</li>
 145 <li><b>Local size</b> - Expected size of the hexahedral mesh in (Solid) or near the given shape</li>
 146 <li><b>Add button</b> - Add the local size to the list of local sizes (showed on the left)</li>
 147 <li><b>Remove button</b> - Remove a local size from the list, select the local size in the list and press <i>Remove</i> </li>
 148 </ul>
 149
 150 \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
 151 (min size, max size, min level, max level), it will be ignored and the default density will be used.
 152
 153 \section hexotic_viscous_layers_parameters Viscous layers
 154
 155 The viscous layers allows you to set up parameters of Viscous Layers supported by MG_Hexa mesher.
 156
 157 \image html hexotic_vl_parameters.png
 158
 159 <ul>
 160 <li><b>Number of layers</b> - number of boundary layers.</li>
 161 <li><b>Size of the first layer</b> - height of the first layer.</li>
 162 <li><b>Direction of the layers</b> - describes whether the layers grow inwards or outwards.</li>
 163 <li><b>Growth</b> - geometric progression for the boundary layer growth.</li>
 164 <li><b>Faces with layers</b> - list of surface references from which the boundary
 165 layers should be grown.</li>
 166 <li><b>Imprinted faces</b> - list of surface references that can be imprinted by
 167 boundary layers.</li>
 168 </ul>
 169
 170 */