Salome HOME
COTECH: Update names of DISTENE products
[plugins/ghs3dplugin.git] / doc / salome / gui / GHS3DPLUGIN / input / ghs3d_hypo.doc
index 0930956412b98b84fe51075ae7068aecac2a1f32..c800d80166694e6969dd7c48e813bd4dc6c5fad0 100644 (file)
@@ -1,12 +1,12 @@
 /*!
 
-\page ghs3d_hypo_page GHS3D Parameters hypothesis
+\page ghs3d_hypo_page MG-Tetra Parameters hypothesis
 
 \anchor ghs3d_top
-GHS3D Parameters hypothesis works only with <b>Tetrahedron (GHS3D)</b> 
+MG-Tetra Parameters hypothesis works only with <b>MG-Tetra</b> 
 algorithm. This algorithm is a commercial software.
 
-To get a licence, visit http://www.distene.com/en/corp/eval-distene.html
+To get a license, visit http://www.distene.com/en/corp/eval-distene.html
 
 \tableofcontents
 
@@ -14,20 +14,20 @@ To get a licence, visit http://www.distene.com/en/corp/eval-distene.html
 
 \image html ghs3d_parameters_basic.png
 
-- <b>Name</b> - allows to define the name of the hypothesis (GHS3D 
+- <b>Name</b> - allows to define the name of the hypothesis (MG-Tetra
 Parameters by default).
 
-- <b>To mesh holes</b> - if checked, the algorithm will 
+- <b>Mesh holes</b> - if checked, the algorithm will 
 create mesh in the holes inside a solid shape, else only the outermost
 shape will be meshed. Volumic elements created within holes are bound
 to the solid.
 
-- <b>To make groups of domains</b> - if checked, the algorithm will
+- <b>Make groups of domains</b> - if checked, the algorithm will
 create groups of just generated elements corresponding to each mesh
 domain.<br>
 
 - <b>Optimization level</b> - allows choosing the required
-optimization level (higher level of optimisation provides better mesh,
+optimization level (higher level of optimization provides better mesh,
 but can be time-consuming):
 
   - none
@@ -46,20 +46,20 @@ but can be time-consuming):
 
 \image html ghs3d_parameters_advanced.png
 
-- <b>Maximum memory size</b> - launches ghs3d software with
+\subsection memory_settings Memory settings
+
+- <b>Maximum memory size</b> - launches MG-Tetra software with
 work space limited to the specified amount of RAM, in Mbytes. If this option is
 checked off, the software will be launched with 7O% of the total RAM space.
 
-- <b>Initial memory size</b> - starts ghs3d software with
+- <b>Initial memory size</b> - starts MG-Tetra software with
 the specified amount of work space, in Mbytes. If this option is checked off, the
 software will be started with 100 Megabytes of working space.
 
-- <b>Working directory</b> - allows defining the folder for input and output
-files of ghs3d software, which are the files starting with "GHS3D_" prefix.
+\subsection log Logs and debug
 
-- <b>Keep working files</b> - allows checking input and output files
-of ghs3d software, while usually these files are removed after the
-launch of the mesher.
+- <b>Working directory</b> - allows defining the folder for input and output
+files of MG-Tetra software, which are the files starting with "GHS3D_" prefix.
 
 - <b>Verbose level</b> - to choose verbosity level in the range from
 0 to 10.
@@ -73,12 +73,26 @@ launch of the mesher.
   - 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>To create new nodes</b> - if this option is checked off, ghs3d
+- <b>Keep all working files</b> - allows checking input and output files
+of MG-Tetra 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.
+
+\subsection advanced_meshing_options Advanced meshing options
+
+- <b>Create new nodes</b> - if this option is checked off, MG-Tetra
 tries to create tetrahedrons using only the nodes of the 2D mesh.
 
-- <b>To remove the initial central point</b> TetMesh-GHS3D adds an internal point 
-at the gravity centre of the bounding box to speed up and to simplify 
+- <b>Remove the initial central point</b> MG-Tetra adds an internal point 
+at the gravity center of the bounding box to speed up and to simplify 
 the meshing process. However, it is possible to refrain from creating 
 this point by using the command line option -no initial central point. This can be
 particularly useful to generate a volume mesh without internal points at all and in some rare cases
@@ -91,7 +105,7 @@ Note: when using this option, the speed of the meshing process may
 decrease, and the quality may change.
 Note: the boundary regeneration may fail with this option, in some rare cases.
 
-- <b>To use boundary recovery version</b> - enables using a
+- <b>Use boundary recovery version</b> - enables using a
 boundary recovery module which tries to
 create volume meshes starting from very poor quality surface meshes
 (almost flat triangles on the surface, high density propagation,
@@ -100,11 +114,11 @@ resulting volume mesh will however most likely have a very poor
 quality (poor aspect ratio of elements, tetrahedra with a very small
 positive volume).
 
-- <b>To use FEM correction</b> - Applies finite-element correction by 
+- <b>Use FEM correction</b> - Applies finite-element correction by 
 replacing overconstrained elements where it is possible. At first the process 
 slices the overconstrained edges and at second the overconstrained 
 facets. This ensures that there are no edges with two boundary
-vertices and that there are no facets with three boundary vertices. TetMesh-GHS3D gives the initial 
+vertices and that there are no facets with three boundary vertices. MG-Tetra gives the initial 
 and final overconstrained edges and facets. It also gives the facets
 which have three edges on the boundary.
 Note: when using this option, the speed of the meshing process may 
@@ -115,31 +129,23 @@ By default, the FEM correction is not used.
 WARNING: Changing the default value of this parameter may dramatically decrease the quality of the resulting mesh.
 
 - <b>Option as text</b> - allows to input in the command line any text
-for ghs3d, for example, advanced options.
+for MG-Tetra, for example, advanced options.
 
 \ref ghs3d_top "Back to top"
 
 \section ghs3d_enforced_vertices Enforced vertices
 
-\note This feature is currently partially available only on meshes with no
-geometry attached. Such meshes can be obtained by
-- Copying an existing mesh
-- Importing a mesh from file
-- Applying a transformation to a mesh a get result in a new mesh
-.
-See below for more details.
-
 \image html ghs3d_enforced_vertices.png
 
-GHS3D algorithm can locally make the mesh finer. It is possible to
+MG-Tetra algorithm can locally make the mesh finer. It is possible to
 define enforced vertices in the volume where the mesh will be detailed.
 A node will be created at the enforced vertex coordinates.
 
 An enforced vertex is defined by:
 - A vertex
-  - from GEOM (Vertex, Compound) - only avaible on meshes with no
+  - from GEOM (Vertex, Compound) - only available on meshes with no
   geometry attached
-  - or from (x,y,z) cartesian coordinates
+  - or from (x,y,z) Cartesian coordinates
 - A constant physical size
 - If a group name is given, the created node will be added to the
 group. If the group does not exist, it is created.
@@ -148,15 +154,9 @@ group. If the group does not exist, it is created.
 
 \section ghs3d_enforced_meshes Enforced Meshes
 
-\note This feature is currently only available on 2D meshes with no
-geometry attached. Such meshes can be obtained by
-- Copying an existing 2D mesh
-- Importing a 2D mesh from file
-- Applying a transformation to a 2D mesh a get result in a new mesh
-
 \image html ghs3d_enforced_meshes.png
 
-GHS3D algorithm can be forced by other meshes, sub-meshes or
+MG-Tetra algorithm can be forced by other meshes, sub-meshes or
 groups. The constraint elements should be contained
 entirely into the solid mesh.
 - The constraint element types are:
@@ -166,7 +166,7 @@ entirely into the solid mesh.
 - If a group name is given, the enforced elements will be added to
 the group. If the group does not exist, it is created.
 
-<br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a Ghs3D hypothesis", including enforced vertices and meshes.
+<br><b>See Also</b> a sample TUI Script of the \ref tui_ghs3d "creation of a MG-Tetra hypothesis", including enforced vertices and meshes.
 
 \ref ghs3d_top "Back to top"