doc/salome/gui/HYBRIDPLUGIN/input/hybrid_hypo.doc

   1 /*!
   2
   3 \page hybrid_hypo_page HYBRID Parameters hypothesis
   4
   5 \anchor hybrid_top
   6 HYBRID Parameters hypothesis works only with <b>MeshGems-Hybrid</b>
   7 algorithm. This algorithm is a commercial software.
   8
   9 To get a licence, visit http://www.distene.com and http://www.meshgems.com/
  10
  11 \tableofcontents
  12
  13 \section hybrid_general_parameters General parameters
  14
  15 \image html hybrid_hypothesis_arguments.png
  16
  17 - <b>hybrid parameters</b> - MeshGems-Hybrid is actually a project, waiting for a distene documentation.
  18 See MeshGems-Hybrid help command:
  19
  20 \verbatim
  21
  22 $> mg-hybrid.exe_Linux_64_juillet2014 --help
  23
  24     =============================================
  25     MG-Hybrid (b8) -- MeshGems 1.3-5 (July, 2014)
  26     =============================================
  27
  28         Distene SAS
  29            Campus Teratec
  30            2, rue de la Piquetterie
  31            91680 Bruyeres le Chatel
  32            FRANCE
  33         Phone: +33(0)970-650-219   Fax: +33(0)169-269-033
  34         EMail: <support@distene.com>
  35
  36         Running MG-Hybrid (b8) (Copyright 2014 by Distene SAS)
  37            date of run: 10-Jul-2014 AT 13:46:28
  38            running on : Linux 2.6.32-431.11.2.el6.centos.plus.x86_64 x86_64
  39            using modules:
  40                 MeshGems-Core 1.3-4
  41
  42         MeshGems is a Registered Trademark of Distene SAS
  43
  44
  45
  46 MeshGems-Hybrid USAGE
  47     mg-hybrid.exe_Linux_64_juillet2014 [-h] [-v <verbose>] [-i <filein>] \
  48         [-o <fileout>] [--max_number_of_threads <maxthreads>] \
  49         [--boundary_layers_surface_ids <list>] \
  50         [--boundary_layers_imprint_ids <list>] \
  51         [--boundary_layers_subdomain_direction <dir>] \
  52         [--height_of_the_first_layer <height>] \
  53         [--number_of_boundary_layers <number>] \
  54         [--boundary_layers_geometric_progression <real>] [--gradation <real>] \
  55         [--element_generation <type>] [--collision_mode <mode>] \
  56         [--add_multinormals <yes|no>] \
  57         [--multinormals_angle_threshold <angle>] [--smooth_normals <yes|no>]
  58
  59   -h --help
  60           prints this help.
  61
  62   -v --verbose <verbose>
  63           Sets the verbosity level parameter.
  64           The <verbose> parameter must be in the range 0 to 10:
  65             0 : no detail
  66             10 : very detailed
  67           Default: 3
  68
  69   -i --in <filein>
  70           Sets the input file.
  71           (MANDATORY)
  72
  73   -o --out <fileout>
  74           Sets the output file.
  75           If unset, _hybrid is appended to the input file basename.
  76           Using an existing file is forbidden.
  77           Using the same file as --in is forbidden.
  78
  79      --max_number_of_threads <maxthreads>
  80           Sets the maximum number of threads to be used in parallel.
  81           Default: 4
  82
  83      --boundary_layers_surface_ids <list>
  84           Comma separated list of surface references to be used to grow layer.
  85
  86      --boundary_layers_imprint_ids <list>
  87           Comma separated list of surface references that are imprinted by
  88           boundary layers.
  89
  90      --boundary_layers_subdomain_direction <dir>
  91           Describes whether the layers grow inwards or outwards.
  92           if <dir> is:
  93            1 : means the layers grow inward
  94           -1 : means the layers grow outward
  95           Default: 1
  96
  97      --height_of_the_first_layer <height>
  98           Sets the height of the first layer.
  99
 100      --number_of_boundary_layers <number>
 101           Sets the number of boundary layers.
 102           Default: 1
 103
 104      --boundary_layers_geometric_progression <real>
 105           Sets the geometric progression for the boundary layer growth (layer
 106           number i position is i * h * g^i).
 107           Default: 1.0
 108
 109      --gradation <real>
 110           Sets the gradation for the boundary layer height.
 111           Default: 2.0
 112
 113      --element_generation <type>
 114           Sets the element type for the mesh generation.
 115           If <type> is:
 116           tetra-dominant : prismatic or hexahedral elements in the boundary
 117           layers, tetrahedra in the remaining volume
 118           hexa-dominant : prismatic or hexahedral elements in the boundary
 119           layers, hexcore in the remaining volume
 120           Default: tetra-dominant
 121
 122      --collision_mode <mode>
 123           Sets the behavior in case of collision between layers.
 124           If <mode> is:
 125           decrease : keep the number of desired layer but decrease the height
 126           of the layers to avoid collision
 127           stop : stop locally the layers generation; the number of desired
 128           layer may not be respected
 129           Default: skip
 130
 131      --add_multinormals <yes|no>
 132           Add extra normals at opening ridges and corners.
 133           Default: no
 134
 135      --multinormals_angle_threshold <angle>
 136           Set the maximum angle between the multiple normals at opening ridges
 137           .
 138           Default: 30
 139
 140      --smooth_normals <yes|no>
 141           Smooth normals at closed ridges and corners.
 142           Default: no
 143
 144
 145  ==============================================================================
 146                    MeshGems-Hybrid SOFTWARE 1.3-5 (July, 2014)
 147                       compiled Jul  4 2014 14:33:45 GMT
 148                                  END OF SESSION
 149            Copyright 2014 by Distene SAS  All Rights Reserved
 150  ==============================================================================
 151       ( Distene SAS
 152         Phone: +33(0)164-908-596     Fax: +33(0)169-269-033
 153         EMail: <support@distene.com> )
 154
 155 \endverbatim
 156 \n
 157
 158 \ref hybrid_top "Back to top"
 159
 160 \section hybrid_advanced_parameters Advanced parameters
 161
 162 \image html hybrid_hypothesis_advanced.png
 163
 164 \subsection log Logs and debug
 165
 166 - <b>Working directory</b> - allows defining the folder for input and output
 167 files of hybrid software, which are the files starting with "HYBRID_" prefix.
 168
 169 - <b>Verbose level</b> - to choose verbosity level in the range from
 170 0 to 10.
 171
 172   - 0, no standard output,
 173
 174   - 2, prints the data, quality statistics of the skin and final
 175   meshes and indicates when the final mesh is being saved. In addition
 176   the software gives indication regarding the CPU time.
 177
 178   - 10, same as 2 plus the main steps in the computation, quality
 179   statistics histogram of the skin mesh, quality statistics histogram
 180   together with the characteristics of the final mesh.
 181
 182 - <b>Print log in a file</b> - if this option is checked on the log is printed in a
 183 file placed in the working directory, otherwise it is printed on the standard output.
 184
 185 - <b>Remove log on success</b> - if this option is checked on the log file is kept only
 186 if an error occurs during the computation. This option is only available if <b>Print log in a file</b>
 187 is enabled (there must be a log file to delete it) and <b>Keep all working files</b> is disabled
 188 (in this case the log file is always kept).
 189
 190 - <b>Keep all working files</b> - allows checking input and output files
 191 of hybrid software, while usually these files are removed after the
 192 launch of the mesher. The log file (if any) is also kept if this option is checked.
 193
 194 \subsection advanced_meshing_options Advanced meshing options
 195
 196 - <b>Option as text</b> - allows to input in the command line any text
 197 for hybrid argument from "mg-hybrid.exe help", and future advanced options...
 198
 199 \ref hybrid_top "Back to top"
 200
 201 \section hybrid_layers_meshes Layers meshes
 202
 203 \image html hybrid_hypothesis_layers.png
 204
 205 HYBRID algorithm mesh layers on groups of faces. Pay attention: theses groups should be defined
 206 into the shell mesh from a previous group defined in the geometry.
 207
 208 - If a group is added, their faces will be source to generate layers
 209 the group.
 210
 211 <br><b>See Also</b> a sample TUI Script of the \ref tui_hybrid "creation of a MG-Hybrid hypothesis".
 212
 213 \ref hybrid_top "Back to top"
 214
 215 */