From: Christophe Bourcier Date: Thu, 6 Jun 2024 13:56:53 +0000 (+0200) Subject: Update documentation X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=0dcbab0a0d0e88fc7a108da74437565a986f9df8;p=plugins%2Fhybridplugin.git Update documentation --- diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_cartesian_core.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_cartesian_core.png new file mode 100644 index 0000000..22ce95a Binary files /dev/null and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_cartesian_core.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hexa_dominant.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hexa_dominant.png new file mode 100644 index 0000000..161a58a Binary files /dev/null and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hexa_dominant.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_advanced.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_advanced.png index bde2d19..2e3147d 100644 Binary files a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_advanced.png and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_advanced.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_arguments.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_arguments.png index 4d3c808..4b921ce 100644 Binary files a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_arguments.png and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_arguments.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_faces.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_faces.png deleted file mode 100644 index 7f0a84f..0000000 Binary files a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_faces.png and /dev/null differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_imprinting.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_imprinting.png new file mode 100644 index 0000000..37f60d0 Binary files /dev/null and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_imprinting.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_layers.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_layers.png index 736847f..f255e4f 100644 Binary files a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_layers.png and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_layers.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_snapping.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_snapping.png new file mode 100644 index 0000000..1fb073b Binary files /dev/null and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_hypothesis_snapping.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_tetra_dominant.png b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_tetra_dominant.png new file mode 100644 index 0000000..a798260 Binary files /dev/null and b/doc/salome/gui/HYBRIDPLUGIN/images/hybrid_tetra_dominant.png differ diff --git a/doc/salome/gui/HYBRIDPLUGIN/input/hybrid_hypo.doc b/doc/salome/gui/HYBRIDPLUGIN/input/hybrid_hypo.doc index e3d8180..66b0330 100644 --- a/doc/salome/gui/HYBRIDPLUGIN/input/hybrid_hypo.doc +++ b/doc/salome/gui/HYBRIDPLUGIN/input/hybrid_hypo.doc @@ -6,55 +6,191 @@ HYBRID Parameters hypothesis works only with MeshGems-Hybrid 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. -- Hybrid parameters - 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" + +- Number of boundary layers - Sets the number of boundary layers to add. + +- Size mode - Define where to sets the boundary layers: + + - Global - Define the layers on all the faces + + - Local - Define the layers on selected faces. To be selected on the tab Faces with layers + +- Height of first layer - Define the height of the first layer + +- Height relative to local surface - If set to yes, the given size is relative to the surface size + +- Growth of boundary layers - Define if the boundary layers will be added inside the domain (Downward growth) or outside the domain (Upward growth). + +- Maximal element angle (degrees) - Sets the maximum internal angles of elements (in degree). +This setting applies to the boundary layer elements only. + +- Geometric progression - Sets the geometric progression for all the boundary layer growths. + +- Imprinting - 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 Faces with imprinting tab. + +- Snapping - 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 Faces with snapping 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...
+Add option - 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. + +- Add multi normals - Add extra normals at opening ridges and +corners. + +- Collision mode - Sets the behavior in case of collision between layers. + + - 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 + +- Gradation - Sets the desired maximum ratio between 2 adjacent edges. + It applies only to the edges which belong to the tetrahedra. + +- Maximum number of threads - Sets the maximum number of threads to be used in parallel. + +- Multi normal angle threshold - Set the maximum angle (in + degrees) between the multiple normals at opening ridges. + +- Smooth normals - Smooth normals at closed ridges and corners. + +\subsection log Logs and debug + +- Working directory - allows defining the folder for input and output +files of hybrid software, which are the files starting with "HYBRID_" prefix. + +- Verbose level - 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. + +- Print log in a file - 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. + +- Remove log on success - 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 Print log in a file +is enabled (there must be a log file to delete it) and Keep all working files is disabled +(in this case the log file is always kept). + +- Keep all working files - 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. + +- Use library - allows to call MG-Hybrid by library instead of executable. +You can also set the environment variable MG_HYBRID_USE_LIB 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 Size mode is set to +Local, 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 Face IDs 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). + +
See Also 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 + +- Hybrid parameters - 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: - - 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 ] [-i ] [-o ] \ - [--global_physical_size ] [--max_number_of_threads ] \ + [--global_physical_size ] \ + [--max_number_of_threads ] \ [--boundary_layer_size_mode ] \ [--boundary_layer_height_relative_to_local_surface_size ] \ - [--number_of_boundary_layers ] [--boundary_layer_global_initial_height ] \ + [--number_of_boundary_layers ] \ + [--boundary_layer_global_initial_height ] \ [--boundary_layer_surface_tags ] \ [--boundary_layer_initial_height_on_surface_tags ] \ [--boundary_layer_geometric_progression ] \ - [--boundary_layer_max_element_angle ] [--boundary_layer_imprinting ] \ - [--boundary_layer_imprinting_tags ] [--boundary_layer_snapping ] \ - [--boundary_layer_snapping_tags ] [--normal_direction ] [--gradation ] \ - [--element_generation ] [--collision_mode ] [--add_multinormals ] \ + [--boundary_layer_max_element_angle ] \ + [--boundary_layer_imprinting ] \ + [--boundary_layer_imprinting_tags ] \ + [--boundary_layer_snapping ] \ + [--boundary_layer_snapping_tags ] [--normal_direction ] \ + [--gradation ] [--element_generation ] \ + [--collision_mode ] [--add_multinormals ] \ [--multinormal_angle_threshold ] [--smooth_normals ] \ [--optimisation ] @@ -89,9 +225,11 @@ MG-HYBRID USAGE --boundary_layer_size_mode Sets the behavior for the boundary layer sizes. If 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 @@ -106,72 +244,80 @@ MG-HYBRID USAGE Sets the height of the first layer. --boundary_layer_surface_tags - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 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 - 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 Sets the element type for the mesh generation. If 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 Sets the behavior in case of collision between layers. If 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 @@ -195,110 +341,15 @@ MG-HYBRID USAGE 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: ) +==================================================================================== + 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...
-Add option - 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. - -- Add multi normals - Add extra normals at opening ridges and -corners. - -- Collision mode - Sets the behavior in case of collision between layers. - - - 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 - -- Gradation - Sets the desired maximum ratio between 2 adjacent edges. - It applies only to the edges which belong to the tetrahedra. - -- Maximum number of threads - Sets the maximum number of threads to be used in parallel. - -- Multi normal angle threshold - Set the maximum angle (in - degrees) between the multiple normals at opening ridges. - -- Smooth normals - Smooth normals at closed ridges and corners. - -\subsection log Logs and debug - -- Working directory - allows defining the folder for input and output -files of hybrid software, which are the files starting with "HYBRID_" prefix. - -- Verbose level - 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. - -- Print log in a file - 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. - -- Remove log on success - 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 Print log in a file -is enabled (there must be a log file to delete it) and Keep all working files is disabled -(in this case the log file is always kept). - -- Keep all working files - 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 Mesh layers on all wrap -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 Mesh layers on all wrap -on Layers meshes 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 Face IDs list. \b Remove button removes -selected IDs from the list. - -
See Also a sample TUI Script of the \ref tui_hybrid "creation of a MG-Hybrid hypothesis". +\endverbatim \ref hybrid_top "Back to top"