Salome HOME
#17784 [EDF] MESH-GEMS-2.9.6 Meshers options
[plugins/ghs3dplugin.git] / doc / salome / gui / GHS3DPLUGIN / input / optimization_hypo.doc
1 /*!
2
3 \page optimization_page MG-Tetra Optimization Parameters hypothesis
4
5 \anchor optimization_top
6 MG-Tetra Optimization Parameters hypothesis works only
7 with <b>MG-Tetra Optimization</b> 
8 algorithm. This algorithm is a commercial software.
9
10 To get a license, visit http://www.meshgems.com/meshgems-products.html
11
12 \tableofcontents
13
14 \section mgtetra_optim_gen_params General parameters
15
16 \image html mgtetra_optim_gen_params.png
17
18 - <b>Name</b> - allows to define the name of the hypothesis (MG-Tetra
19 Parameters by default).
20
21 - <b>Optimization</b> - sets the optimisation type. If <b>Optimization</b> is:
22   - No : no optimisation is applied
23   - Yes (default): optimisation is performed upon mesh generation using
24           the <b>Optimisation level</b> parameter 
25   - Only : only optimisation is performed to an existing mesh.
26
27 - <b>Optimization level</b> - allows choosing the required
28 optimization level (higher level of optimization provides better mesh,
29 but can be time-consuming):
30   - none
31   - light
32   - medium (standard)
33   - standard+
34   - strong
35
36 - <b>Split overconstrained elements</b> - sets treatment of element
37 having all their vertices on the input surface. 
38 If <b>Split overconstrained elements</b> is:
39   - No (default): no correction is applied
40   - Yes : correction is applied upon mesh generation
41   - Only : only correction is applied to an existing mesh.
42
43 - <b>PThreads mode</b> - sets optimization mode when using multithread
44 capabilities. Valid values are:
45   - Safe : slower but quality can only get better
46   - Aggressive : faster but quality may be altered
47   - None (default): not activated.
48
49 - <b>Max number of threads</b> - sets the maximum number of threads to
50 be used in parallel.
51
52 - <b>Smooth off sliver elements</b> - activates elimination of sliver
53 elements as much as possible.
54
55 - <b>Create new nodes</b> - allows insertion of new nodes.
56
57 \ref optimization_top "Back to top"
58
59
60 \section mgtetra_optim_advanced_parameters Advanced parameters
61
62 \image html mgtetra_optim_adv_params.png
63
64 \subsection mgtetra_optim_memory_settings Memory settings
65
66 - <b>Initial memory size</b> - starts MG-Tetra software with
67 the specified amount of work space, in Mbytes. If this option is checked off, the
68 software will be started with 100 Megabytes of working space.
69
70 - <b>Maximum memory size</b> - launches MG-Tetra software with
71 work space limited to the specified amount of RAM, in Mbytes. If this option is
72 checked off, the software will be launched with 7O% of the total RAM space.
73
74 \subsection mgtetra_optim_log Logs and debug
75
76 - <b>Working directory</b> - allows defining the folder for input and output
77 files of MG-Tetra software, which are the files starting with "GHS3D_" prefix.
78
79 - <b>Verbose level</b> - to choose verbosity level in the range from
80 0 to 10.
81
82   - 0, no standard output,
83
84   - 2, prints the data, quality statistics of the skin and final
85   meshes and indicates when the final mesh is being saved. In addition
86   the software gives indication regarding the CPU time.
87
88   - 10, same as 2 plus the main steps in the computation, quality
89   statistics histogram of the skin mesh, quality statistics histogram
90   together with the characteristics of the final mesh.
91   
92 - <b>Print log in a file</b> - if this option is checked on the log is
93 printed in a file placed in the working directory, otherwise it is
94 printed on the standard output.
95
96 - <b>Remove log on success</b> - if this option is checked on the log
97 file is kept only if an error occurs during the computation. This
98 option is only available if <b>Print log in a file</b> is enabled
99 (there must be a log file to delete it) and <b>Keep all working
100   files</b> is disabled (in this case the log file is always kept).
101
102 - <b>Keep all working files</b> - allows checking input and output
103 files of MG-Tetra software, while usually these files are removed
104 after the launch of the mesher. The log file (if any) is also kept if
105 this option is checked.
106
107 \subsection mgtetra_optim_advanced_meshing_options Advanced meshing options
108
109 - A table allows to input in the command line any text for MG-Tetra,
110 for example, advanced options.<br> 
111
112 - <b>Add option</b> - adds a line to the table where you can type an
113 option and its value as text. A check box in the first column
114 activates/deactivates the option of the current row. A deactivated
115 option will be erased upon pressing \a Ok.
116
117 <br><b>See Also</b> a sample TUI Script of the 
118 \ref tui_ghs3d "creation of a MG-Tetra Optimization hypothesis".
119
120 \ref optimization_top "Back to top"
121
122 */