Salome HOME
Revert "Synchronize adm files"
[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 HexoticPLUGINBuilder 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 HexoticPLUGINBuilder 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 \subsection tui_local_size Local size
28
29 \image html hexotic_local_size_example.png Example of use of a local size on the skin of a sphere
30
31
32 \ref tui_hexotic "Back to top"
33
34 \section tui_hexotic_sd_mode Effect of the sub-domain mode
35
36 This example illustrates the sub-domain mode of Hexotic.
37
38 \subsection tui_hexotic_sd_mode1 Sub-domain mode = 1
39
40 <h2>Example of sub-domain mode 1 with Hexotic algorithm:</h2>
41 \tui_script{hexoticsubdom1.py}
42
43 \image html hexotic_sd_mode_1.png Hexotic mesh of a box cut by a holed sphere ( sd = 1 )
44
45 \ref tui_hexotic "Back to top"
46
47 \subsection tui_hexotic_sd_mode2 Sub-domain mode = 2
48
49 <h2>Example of sub-domain mode 2 with Hexotic algorithm:</h2>
50 \tui_script{hexoticsubdom2.py}
51
52 \image html hexotic_sd_mode_2.png Hexotic mesh of a box cut by a holed sphere ( sd = 2 )
53
54 \ref tui_hexotic "Back to top"
55
56 \subsection tui_hexotic_sd_mode3 Sub-domain mode = 3
57
58 <h2>Example of sub-domain mode 3 with Hexotic algorithm:</h2>
59 \tui_script{hexoticsubdom3.py}
60
61 \image html hexotic_sd_mode_3.png Hexotic mesh of a box cut by a holed sphere ( sd = 3 )
62
63 \ref tui_hexotic "Back to top"
64
65 \subsection tui_hexotic_sd_mode4 Sub-domain mode = 4
66
67 <h2>Example of sub-domain mode 4 with Hexotic algorithm:</h2>
68 \tui_script{hexoticsubdom4.py}
69
70 \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 )
71
72 \ref tui_hexotic "Back to top"
73
74 */