Salome HOME
Fix compilation problems
[plugins/hexoticplugin.git] / doc / salome / gui / HexoticPLUGIN / input / hexoticplugin_python_interface.doc
1 /*!
2
3 \page hexoticplugin_python_interface_page Python Interface
4
5 Python package HexoticPLUGIN defines several classes, destined for creation of the 3D meshes.
6
7 Hexotic meshing plugin dynamically adds several methods to the smeshBuilder.Mesh class to create meshing algorithms.
8
9 Below you can see an example of usage of the HexoticPlugin Python API for mesh generation:
10
11 \anchor tui_hexotic
12
13 -# \ref tui_hexotic_basic
14 -# \ref tui_hexotic_sd_mode
15   -# \ref tui_hexotic_sd_mode1
16   -# \ref tui_hexotic_sd_mode2
17   -# \ref tui_hexotic_sd_mode3
18   -# \ref tui_hexotic_sd_mode4
19
20 \section tui_hexotic_basic Construction of Mesh using Hexotic algorithm
21
22 <h2>Example of mesh generation with Hexotic algorithm:</h2>
23 \tui_script{hexoticdemo.py}
24
25 \image html hexotic_basic_subdivisions_4_8.png Left: Hexotic mesh without hypothesis, right: Hexotic mesh with an hypothesis defined by minl=4 and maxl=8
26
27 \ref tui_hexotic "Back to top"
28
29 \section tui_hexotic_sd_mode Effect of the sub-domain mode
30
31 This example illustrates the sub-domain mode of Hexotic.
32
33 \subsection tui_hexotic_sd_mode1 Sub-domain mode = 1
34
35 <h2>Example of sub-domain mode 1 with Hexotic algorithm:</h2>
36 \tui_script{hexoticsubdom1.py}
37
38 \image html hexotic_sd_mode_1.png Hexotic mesh of a box cut by a holed sphere ( sd = 1 )
39
40 \ref tui_hexotic "Back to top"
41
42 \subsection tui_hexotic_sd_mode2 Sub-domain mode = 2
43
44 <h2>Example of sub-domain mode 2 with Hexotic algorithm:</h2>
45 \tui_script{hexoticsubdom2.py}
46
47 \image html hexotic_sd_mode_2.png Hexotic mesh of a box cut by a holed sphere ( sd = 2 )
48
49 \ref tui_hexotic "Back to top"
50
51 \subsection tui_hexotic_sd_mode3 Sub-domain mode = 3
52
53 <h2>Example of sub-domain mode 3 with Hexotic algorithm:</h2>
54 \tui_script{hexoticsubdom3.py}
55
56 \image html hexotic_sd_mode_3.png Hexotic mesh of a box cut by a holed sphere ( sd = 3 )
57
58 \ref tui_hexotic "Back to top"
59
60 \subsection tui_hexotic_sd_mode4 Sub-domain mode = 4
61
62 <h2>Example of sub-domain mode 4 with Hexotic algorithm:</h2>
63 \tui_script{hexoticsubdom4.py}
64
65 \image html hexotic_sd_mode_4.png Hexotic mesh of a box cut by a plane ( On the left, sd = 3: the internal surface is ignored ; on the right sd = 4: all sub-domains are meshed )
66
67 \ref tui_hexotic "Back to top"
68
69 */