HYBRID Parameters hypothesis works only with <b>MeshGems-Hybrid</b>
algorithm. This algorithm is a commercial software.
-To get a licence, visit http://www.distene.com and http://www.meshgems.com/
+To get a license, visit https://www.spatial.com/products/3d-precise-mesh
\tableofcontents
\section hybrid_general_parameters General parameters
-\image html hybrid_hypothesis_arguments.png
+MG-Hybrid allows to generate meshes with:
+- tetrahedral or hexahedral elements for the main core of the shape,
+- prismatic layers (prisms or hexahedra) depending on the surface mesh (triangles or quadrangles)
+- pyramids doing the junction if needed between tetrahedra (or prisms) and hexahedra.
-- <b>Hybrid parameters</b> - See distene documentation or MeshGems-Hybrid help command:
+\image html hybrid_tetra_dominant.png "Tetra dominant"
+
+\image html hybrid_hexa_dominant.png "Hexa dominant"
+
+\image html hybrid_cartesian_core.png "Cartesian core"
+
+\image html hybrid_hypothesis_arguments.png "Hybrid arguments"
+
+- <b>Number of boundary layers</b> - Sets the number of boundary layers to add.
+
+- <b>Size mode</b> - Define where to sets the boundary layers:
+
+ - <b>Global</b> - Define the layers on all the faces
+
+ - <b>Local</b> - Define the layers on selected faces. To be selected on the tab <b>Faces with layers</b>
+
+- <b>Height of first layer</b> - Define the height of the first layer
+
+- <b>Height relative to local surface</b> - If set to yes, the given size is relative to the surface size
+
+- <b>Growth of boundary layers</b> - Define if the boundary layers will be added inside the domain (<b>Downward growth</b>) or outside the domain (<b>Upward growth</b>).
+
+- <b>Maximal element angle (degrees)</b> - Sets the maximum internal angles of elements (in degree).
+This setting applies to the boundary layer elements only.
+
+- <b>Geometric progression</b> - Sets the geometric progression for all the boundary layer growths.
+
+- <b>Imprinting</b> - If set to yes, allows to define where the boundary layers will be imprinted (the inlets and oulets in a CFD study). These faces are to be selected in the <b>Faces with imprinting</b> tab.
+
+- <b>Snapping</b> - If set to yes, allows to define where the boundary layers are already imprinted on the 2D mesh (the inlets and oulets in a CFD study). These faces are to be selected in the <b>Faces with snapping</b> tab.
+
+\ref hybrid_top "Back to top"
+
+\section hybrid_advanced_parameters Advanced parameters
+
+\image html hybrid_hypothesis_advanced.png
+
+\subsection advanced_meshing_options Advanced meshing options
+
+- A table allows to input in the command line any text
+ for hybrid argument from "mg-hybrid.exe help", and future advanced options... <br>
+<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.
+
+- <b>Add multi normals</b> - Add extra normals at opening ridges and
+corners.
+
+- <b>Collision mode</b> - Sets the behavior in case of collision between layers.
+
+ - <b>decrease</b> - keeps the number of desired layer but decreases the height of the layers to
+ avoid any collision
+
+ - <b>stop</b> - stops locally the generation of layers to avoid collisions; the number of
+ generated layers may differ from the specified desired number
+
+- <b>Gradation</b> - Sets the desired maximum ratio between 2 adjacent edges.
+ It applies only to the edges which belong to the tetrahedra.
+
+- <b>Maximum number of threads</b> - Sets the maximum number of threads to be used in parallel.
+
+- <b>Multi normal angle threshold</b> - Set the maximum angle (in
+ degrees) between the multiple normals at opening ridges.
+
+- <b>Smooth normals</b> - Smooth normals at closed ridges and corners.
+
+\subsection log Logs and debug
+
+- <b>Working directory</b> - allows defining the folder for input and output
+files of hybrid software, which are the files starting with "HYBRID_" prefix.
+
+- <b>Verbose level</b> - to choose verbosity level in the range from
+0 to 10.
+
+ - 0, no standard output,
+
+ - 2, prints the data, quality statistics of the skin and final
+ meshes and indicates when the final mesh is being saved. In addition
+ the software gives indication regarding the CPU time.
+
+ - 10, same as 2 plus the main steps in the computation, quality
+ statistics histogram of the skin mesh, quality statistics histogram
+ together with the characteristics of the final mesh.
+
+- <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.
+
+- <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).
+
+- <b>Keep all working files</b> - allows checking input and output files
+of hybrid 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.
+
+- <b>Use library</b> - allows to call MG-Hybrid by library instead of executable.
+You can also set the environment variable <b>MG_HYBRID_USE_LIB</b> to change this default behaviour.
+
+\ref hybrid_top "Back to top"
+
+\section hybrid_layers_faces Faces with layers
+
+\image html hybrid_hypothesis_layers.png
+
+In case of a mesh based on geometry, if <b>Size mode</b> is set to
+<b>Local</b>, this tab becomes activated. You can specify geometrical
+faces on which boundary layers should be constructed (i.e. corresponding to the walls in a CFD study).
+After clicking
+\a Selection button (arrow) you can select faces either in the
+Viewer or in the Object Browser. \b Add button adds IDs of the
+selected faces to the <b>Face IDs</b> list. \b Remove button removes
+selected IDs from the list.
+
+\section hybrid_layers_faces Faces with imprinting
+
+\image html hybrid_hypothesis_imprinting.png
+
+If *Imprinting* is set to yes, this tab becomes activated. You can select the faces
+where the layers will be imprinted (i.e. corresponding to the inlets and outlets in a CFD study).
+
+\section hybrid_layers_faces Faces with snapping
+
+\image html hybrid_hypothesis_snapping.png
+
+Instead of letting MG-Hybrid do the imprinting on faces, you can tell to use existing faces where
+cells corresponding to the imprinting are already present (created by the surface mesh generation
+with dedicated algorithms).
+
+<br><b>See Also</b> a sample TUI Script of the \ref tui_hybrid "creation of a MG-Hybrid hypothesis".
+
+\ref hybrid_top "Back to top"
+
+\section hybrid_all_parameters All MG-hybrid parameters
+
+- <b>Hybrid parameters</b> - See documentation in $MESHGEMS_ROOT_DIR/Docs/mg-hybrid_user_manual.pdf
+or MG-Hybrid help command:
\verbatim
$> mg-hybrid.exe --help
- ==========================================
- MG-Hybrid -- MeshGems 2.9-6 (August, 2019)
- ==========================================
-
- Distene SAS
- Campus Teratec
- 2, rue de la Piquetterie
- 91680 Bruyeres le Chatel
- FRANCE
- Phone: +33(0)970-650-219 Fax: +33(0)169-269-033
- EMail: <support@distene.com>
-
- Running MG-Hybrid (Copyright 2014-2019 by Distene SAS)
- date of run: 07-Oct-2019 AT 17:40:47
- running on : Linux 3.16.0-4-amd64 x86_64
+ ============================================
+ MG-Hybrid -- MeshGems 2.15-1 (January, 2023)
+ ============================================
+
+
+ Running MG-Hybrid (Copyright 2014-2023 by Dassault Systemes SE)
+ date of run: 06-Jun-2024 AT 13:13:22
+ running on : Linux 5.11.12-300.fc34.x86_64 x86_64
using modules:
- MeshGems-Core 2.9-6
+ MeshGems-Core 2.15-1
- MeshGems is a Registered Trademark of Distene SAS
+ MeshGems is a commercial trademark of Dassault Systemes SE
MG-HYBRID USAGE
mg-hybrid.exe [-h] [-v <verbose>] [-i <filein>] [-o <fileout>] \
- [--global_physical_size <size>] [--max_number_of_threads <maxthreads>] \
+ [--global_physical_size <size>] \
+ [--max_number_of_threads <maxthreads>] \
[--boundary_layer_size_mode <mode>] \
[--boundary_layer_height_relative_to_local_surface_size <yes|no>] \
- [--number_of_boundary_layers <number>] [--boundary_layer_global_initial_height <height>] \
+ [--number_of_boundary_layers <number>] \
+ [--boundary_layer_global_initial_height <height>] \
[--boundary_layer_surface_tags <list>] \
[--boundary_layer_initial_height_on_surface_tags <list>] \
[--boundary_layer_geometric_progression <real>] \
- [--boundary_layer_max_element_angle <size>] [--boundary_layer_imprinting <boolean>] \
- [--boundary_layer_imprinting_tags <list>] [--boundary_layer_snapping <boolean>] \
- [--boundary_layer_snapping_tags <list>] [--normal_direction <dir>] [--gradation <real>] \
- [--element_generation <type>] [--collision_mode <mode>] [--add_multinormals <yes|no>] \
+ [--boundary_layer_max_element_angle <size>] \
+ [--boundary_layer_imprinting <boolean>] \
+ [--boundary_layer_imprinting_tags <list>] \
+ [--boundary_layer_snapping <boolean>] \
+ [--boundary_layer_snapping_tags <list>] [--normal_direction <dir>] \
+ [--gradation <real>] [--element_generation <type>] \
+ [--collision_mode <mode>] [--add_multinormals <yes|no>] \
[--multinormal_angle_threshold <angle>] [--smooth_normals <yes|no>] \
[--optimisation <type>]
--boundary_layer_size_mode <mode>
Sets the behavior for the boundary layer sizes.
If <mode> is:
- global: the boundary_layer_global_initial_height is used to compute the layer heights
+ global: the boundary_layer_global_initial_height is used to compute
+ the layer heights
local: the boundary_layer_surface_tags and
- boundary_layer_initial_height_on_surface_tags are used to compute the layer heights
+ boundary_layer_initial_height_on_surface_tags are used to compute
+ the layer heights
Default: global
--boundary_layer_height_relative_to_local_surface_size <yes|no>
Sets the height of the first layer.
--boundary_layer_surface_tags <list>
- Comma separated list of surface references to be used to grow boundary layers.
+ Comma separated list of surface references to be used to grow
+ boundary layers.
--boundary_layer_initial_height_on_surface_tags <list>
- Comma separated list of initial heights to be used to grow boundary layers.
+ Comma separated list of initial heights to be used to grow boundary
+ layers.
--boundary_layer_geometric_progression <real>
- Sets the geometric progression for all the boundary layer growths (position of layer
- number i is h * g^(i-1)).
+ Sets the geometric progression for all the boundary layer growths
+ (position of layer number i is h * g^(i-1)).
Default: 1.0
--boundary_layer_max_element_angle <size>
- Sets the maximum internal angles of elements (in degree). This setting applies to the
- boundary layer elements only.
+ Sets the maximum internal angles of elements (in degree). This
+ setting applies to the boundary layer elements only.
Default: 165.
--boundary_layer_imprinting <boolean>
- Activates the imprinting of the boundary layers. The parts of the surface where the
- layers have to be imprinted are defined through the option
- --boundary_layer_imprinting_tags
+ Activates the imprinting of the boundary layers. The parts of the
+ surface where the layers have to be imprinted are defined through the
+ option --boundary_layer_imprinting_tags
Default: no imprinting
--boundary_layer_imprinting_tags <list>
- Comma separated list of surface references that have to be imprinted by boundary layers.
+ Comma separated list of surface references that have to be imprinted
+ by boundary layers.
--boundary_layer_snapping <boolean>
- Activates the snapping of the generated boundary layers on the surface. The parts of the
- surface where the layers have to be snapped into are defined through the option
- --boundary_layer_snapping_tags
+ Activates the snapping of the generated boundary layers on the
+ surface. The parts of the surface where the layers have to be snapped
+ into are defined through the option --boundary_layer_snapping_tags
Default: no snapping
--boundary_layer_snapping_tags <list>
- Comma separated list of surface references that are imprinted by boundary layers.
+ Comma separated list of surface references that are imprinted by
+ boundary layers.
--normal_direction <dir>
- Specifies whether mg-hybrid should use the surface normals or the inverse of the surface
- normals.
+ Specifies whether mg-hybrid should use the surface normals or the
+ inverse of the surface normals.
if <dir> is:
- 1 : means the layers grow in the same direction as the normals to the surface
- -1 : means the layers grow in the opposite direction to the normals of the surface
+ 1 : means the layers grow in the same direction as the normals to
+ the surface
+ -1 : means the layers grow in the opposite direction to the normals
+ of the surface
Default: 1
--gradation <real>
- Sets the desired maximum ratio between 2 adjacent edges. It applies only to the edges
- which belong to the tetrahedra.
+ Sets the desired maximum ratio between 2 adjacent edges. It applies
+ only to the edges which belong to the tetrahedra.
Default: 2.0
--element_generation <type>
Sets the element type for the mesh generation.
If <type> is:
- tetra_dominant : prismatic or hexahedral elements in the boundary layers, tetrahedra in
- the remaining volume
- hexa_dominant : prismatic or hexahedral elements in the boundary layers, mixture of
- hexahedra and tetrahedra in the remaining volume
- cartesian_core : cartesian hexa core with tetrahedra and pyramids in the remaining
+ tetra_dominant : prismatic or hexahedral elements in the boundary
+ layers, tetrahedra in the remaining volume
+ hexa_dominant : prismatic or hexahedral elements in the boundary
+ layers, mixture of hexahedra and tetrahedra in the remaining
volume
- extrusion_only : only prismatic or hexahedral elements near the boundary are generated.
- The remaining volume is not filled.
+ cartesian_core : cartesian hexa core with tetrahedra and pyramids
+ in the remaining volume
+ extrusion_only : only prismatic or hexahedral elements near the
+ boundary are generated. The remaining volume is not filled.
Default: tetra_dominant
--collision_mode <mode>
Sets the behavior in case of collision between layers.
If <mode> is:
- decrease : keeps the number of desired layer but decreases the height of the layers to
- avoid any collision
- stop : stops locally the generation of layers to avoid collisions; the number of
- generated layers may differ from the specified desired number
+ decrease : keeps the number of desired layer but decreases the
+ height of the layers to avoid any collision
+ stop : stops locally the generation of layers to avoid collisions;
+ the number of generated layers may differ from the specified
+ desired number
Default: stop
--add_multinormals <yes|no>
Default: yes.
-================================================================================
- MG-Hybrid -- MeshGems 2.9-6 (August, 2019)
- END OF SESSION - MG-Hybrid (Copyright 2014-2019 by Distene SAS)
- compiled Sep 2 2019 23:42:41 on Linux_64
- MeshGems is a Registered Trademark of Distene SAS
-================================================================================
- ( Distene SAS
- Phone: +33(0)970-650-219 Fax: +33(0)169-269-033
- EMail: <support@distene.com> )
+====================================================================================
+ MG-Hybrid -- MeshGems 2.15-1 (January, 2023)
+ END OF SESSION - MG-Hybrid (Copyright 2014-2023 by Dassault Systemes SE)
+ compiled Jan 18 2023 13:33:47 on Linux_64
+ MeshGems is a commercial trademark of Dassault Systemes SE
+====================================================================================
-\endverbatim
-\ref hybrid_top "Back to top"
-
-\section hybrid_advanced_parameters Advanced parameters
-
-\image html hybrid_hypothesis_advanced.png
-
-\subsection advanced_meshing_options Advanced meshing options
-
-- A table allows to input in the command line any text
- for hybrid argument from "mg-hybrid.exe help", and future advanced options... <br>
-<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.
-
-- <b>Add multi normals</b> - Add extra normals at opening ridges and
-corners.
-
-- <b>Collision mode</b> - Sets the behavior in case of collision between layers.
-
- - <b>decrease</b> - keeps the number of desired layer but decreases the height of the layers to
- avoid any collision
-
- - <b>stop</b> - stops locally the generation of layers to avoid collisions; the number of
- generated layers may differ from the specified desired number
-
-- <b>Gradation</b> - Sets the desired maximum ratio between 2 adjacent edges.
- It applies only to the edges which belong to the tetrahedra.
-
-- <b>Maximum number of threads</b> - Sets the maximum number of threads to be used in parallel.
-
-- <b>Multi normal angle threshold</b> - Set the maximum angle (in
- degrees) between the multiple normals at opening ridges.
-
-- <b>Smooth normals</b> - Smooth normals at closed ridges and corners.
-
-\subsection log Logs and debug
-
-- <b>Working directory</b> - allows defining the folder for input and output
-files of hybrid software, which are the files starting with "HYBRID_" prefix.
-
-- <b>Verbose level</b> - to choose verbosity level in the range from
-0 to 10.
-
- - 0, no standard output,
-
- - 2, prints the data, quality statistics of the skin and final
- meshes and indicates when the final mesh is being saved. In addition
- the software gives indication regarding the CPU time.
-
- - 10, same as 2 plus the main steps in the computation, quality
- statistics histogram of the skin mesh, quality statistics histogram
- together with the characteristics of the final mesh.
-
-- <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.
-
-- <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).
-
-- <b>Keep all working files</b> - allows checking input and output files
-of hybrid 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.
-
-\ref hybrid_top "Back to top"
-
-\section hybrid_layers_meshes Layers meshes
-
-\image html hybrid_hypothesis_layers.png
-
-HYBRID algorithm mesh layers on groups of faces. If <b>Mesh layers on all wrap</b>
-is checked, all wrap is meshed as layers (as boundary_layers_surface_ids 5), else
-only submeshes selected an added are meshed as layers (as boundary_layers_surface_ids 6).
-Pay attention: theses groups should be defined
-into the shell mesh from a previous group defined in the geometry.
-
-
-\ref hybrid_top "Back to top"
-
-\section hybrid_layers_faces Faces with layers
-
-\image html hybrid_hypothesis_faces.png
-
-In case of a mesh based on geometry, if <b>Mesh layers on all wrap</b>
-on <b>Layers meshes</b> tab is unchecked, you can specify geometrical
-faces on which boundary layers should be constructed. After clicking
-\a Selection button (arrow) you can select faces either in the
-Viewer or in the Object Browser. \b Add button adds IDs of the
-selected faces to the <b>Face IDs</b> list. \b Remove button removes
-selected IDs from the list.
-
-<br><b>See Also</b> a sample TUI Script of the \ref tui_hybrid "creation of a MG-Hybrid hypothesis".
+\endverbatim
\ref hybrid_top "Back to top"
