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>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>Make groups of domains</b> - if checked, the algorithm will
  26 create groups of just generated elements corresponding to each mesh
  27 domain.<br>
  28
  29 - <b>Optimization level</b> - allows choosing the required
  30 optimization level (higher level of optimisation provides better mesh,
  31 but can be time-consuming):
  32
  33   - none
  34
  35   - light
  36
  37   - medium (standard)
  38
  39   - standard+
  40
  41   - strong
  42
  43 \ref ghs3d_top "Back to top"
  44
  45 \section ghs3d_advanced_parameters Advanced parameters
  46
  47 \image html ghs3d_parameters_advanced.png
  48
  49 \subsection memory_settings Memory settings
  50
  51 - <b>Maximum memory size</b> - launches ghs3d software with
  52 work space limited to the specified amount of RAM, in Mbytes. If this option is
  53 checked off, the software will be launched with 7O% of the total RAM space.
  54
  55 - <b>Initial memory size</b> - starts ghs3d software with
  56 the specified amount of work space, in Mbytes. If this option is checked off, the
  57 software will be started with 100 Megabytes of working space.
  58
  59 \subsection log Logs and debug
  60
  61 - <b>Working directory</b> - allows defining the folder for input and output
  62 files of ghs3d software, which are the files starting with "GHS3D_" prefix.
  63
  64 - <b>Verbose level</b> - to choose verbosity level in the range from
  65 0 to 10.
  66
  67   - 0, no standard output,
  68
  69   - 2, prints the data, quality statistics of the skin and final
  70   meshes and indicates when the final mesh is being saved. In addition
  71   the software gives indication regarding the CPU time.
  72
  73   - 10, same as 2 plus the main steps in the computation, quality
  74   statistics histogram of the skin mesh, quality statistics histogram
  75   together with the characteristics of the final mesh.
  76
  77 - <b>Print log in a file</b> - if this option is checked on the log is printed in a
  78 file placed in the working directory, otherwise it is printed on the standard output.
  79
  80 - <b>Remove log on success</b> - if this option is checked on the log file is kept only
  81 if an error occurs during the computation. This option is only available if <b>Print log in a file</b>
  82 is enabled (there must be a log file to delete it) and <b>Keep all working files</b> is disabled
  83 (in this case the log file is always kept).
  84
  85 - <b>Keep all working files</b> - allows checking input and output files
  86 of ghs3d software, while usually these files are removed after the
  87 launch of the mesher. The log file (if any) is also kept if this option is checked.
  88
  89 \subsection advanced_meshing_options Advanced meshing options
  90
  91 - <b>Create new nodes</b> - if this option is checked off, ghs3d
  92 tries to create tetrahedrons using only the nodes of the 2D mesh.
  93
  94 - <b>Remove the initial central point</b> TetMesh-GHS3D adds an internal point
  95 at the gravity centre of the bounding box to speed up and to simplify
  96 the meshing process. However, it is possible to refrain from creating
  97 this point by using the command line option -no initial central point. This can be
  98 particularly useful to generate a volume mesh without internal points at all and in some rare cases
  99 at the boundary regeneration phase when it is impossible to proceed
 100 with the standard options
 101 (for example, when one dimension of the domain is more than 20 times greater than the other two).
 102 Use this option if the boundary regeneration has failed with the standard parameters and before using
 103 the recovery version (command line option -C).
 104 Note: when using this option, the speed of the meshing process may
 105 decrease, and the quality may change.
 106 Note: the boundary regeneration may fail with this option, in some rare cases.
 107
 108 - <b>Use boundary recovery version</b> - enables using a
 109 boundary recovery module which tries to
 110 create volume meshes starting from very poor quality surface meshes
 111 (almost flat triangles on the surface, high density propagation,
 112 extreme aspect ratios, etc.) which fails with the standard version. The
 113 resulting volume mesh will however most likely have a very poor
 114 quality (poor aspect ratio of elements, tetrahedra with a very small
 115 positive volume).
 116
 117 - <b>Use FEM correction</b> - Applies finite-element correction by
 118 replacing overconstrained elements where it is possible. At first the process
 119 slices the overconstrained edges and at second the overconstrained
 120 facets. This ensures that there are no edges with two boundary
 121 vertices and that there are no facets with three boundary vertices. TetMesh-GHS3D gives the initial
 122 and final overconstrained edges and facets. It also gives the facets
 123 which have three edges on the boundary.
 124 Note: when using this option, the speed of the meshing process may
 125 decrease, quality may change, and the smallest volume may be smaller.
 126 By default, the FEM correction is not used.
 127
 128 - <b>Volumic gradation</b> - Defines the volumic ratio between 2 consecutive elements.
 129 WARNING: Changing the default value of this parameter may dramatically decrease the quality of the resulting mesh.
 130
 131 - <b>Option as text</b> - allows to input in the command line any text
 132 for ghs3d, for example, advanced options.
 133
 134 \ref ghs3d_top "Back to top"
 135
 136 \section ghs3d_enforced_vertices Enforced vertices
 137
 138 \image html ghs3d_enforced_vertices.png
 139
 140 GHS3D algorithm can locally make the mesh finer. It is possible to
 141 define enforced vertices in the volume where the mesh will be detailed.
 142 A node will be created at the enforced vertex coordinates.
 143
 144 An enforced vertex is defined by:
 145 - A vertex
 146   - from GEOM (Vertex, Compound) - only avaible on meshes with no
 147   geometry attached
 148   - or from (x,y,z) cartesian coordinates
 149 - A constant physical size
 150 - If a group name is given, the created node will be added to the
 151 group. If the group does not exist, it is created.
 152
 153 \ref ghs3d_top "Back to top"
 154
 155 \section ghs3d_enforced_meshes Enforced Meshes
 156
 157 \image html ghs3d_enforced_meshes.png
 158
 159 GHS3D algorithm can be forced by other meshes, sub-meshes or
 160 groups. The constraint elements should be contained
 161 entirely into the solid mesh.
 162 - The constraint element types are:
 163   - NODE
 164   - EDGE
 165   - FACE
 166 - If a group name is given, the enforced elements will be added to
 167 the group. If the group does not exist, it is created.
 168
 169 <br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a Ghs3D hypothesis", including enforced vertices and meshes.
 170
 171 \ref ghs3d_top "Back to top"
 172
 173 */