Salome HOME
updated copyright message
[modules/hexablock.git] / doc / creategrids.rst
1 :tocdepth: 3
2
3 .. _creategrids:
4
5 ======================
6 Create cartesian grids
7 ======================
8
9 To create a **Cartesian Grid** in the **Main Menu** select **Model -> Construction -> Make Grid**.
10
11 Three kinds of grid can be created:
12
13 - simple cartesian grid (see :ref:`guicartgridsimple`),
14 - uniform cartesian grid (see :ref:`guicartgriduniform`),
15 - custom cartesian grid (see :ref:`guicartgridcustom`).
16
17 .. _guicartgridsimple:
18
19 Simple cartesian grid
20 =====================
21
22 To create a simple cartesian grid, select radio button **Simple**:
23
24 .. image:: _static/gui_make_cart_grid_simple.png
25    :align: center
26
27 .. centered::
28       Dialogue Box for a Simple cartesian grid
29
30
31 The following data are required:
32
33 - *nb X*: The number of hexahedra along the X axis
34 - *nb Y*: The number of hexahedra along the Y axis
35 - *nb Z*: The number of hexahedra along the Z axis
36
37 The result of this action is:
38
39 .. image:: _static/cartgridsimple.png
40    :align: center
41
42 .. centered::
43    Simple Cartesian Grid
44
45 TUI command: :ref:`tuicartgridsimple`
46
47
48 .. _guicartgriduniform:
49
50 Uniform cartesian grid
51 ======================
52
53 To create an uniform cartesian grid, select radio button **Uniform**:
54
55 .. image:: _static/gui_make_cart_grid_uniform.png
56    :align: center
57
58 .. centered::
59    Dialogue Box for an Uniform cartesian grid
60
61
62 The following data are required:
63
64 - *origin*: The vertex of the origin
65 - *vec X* : The X vector
66 - *vec Y* : The Y vector
67 - *vec Z* : The Z vector
68 - *len X* : The length of an hexahedra on the X axis
69 - *len Y* : The length of an hexahedra on the Y axis
70 - *len Z* : The length of an hexahedra on the Z axis
71 - *nb X*  : The number of hexahedra on the X axis
72 - *nb Y*  : The number of hexahedra on the Y axis
73 - *nb Z*  : The number of hexahedra on the Z axis
74
75 Clicking on "Apply" on the previous dialog box will produce the following grid (Uniform hexahedra, different sizes on the three axis):
76
77 .. image:: _static/cartgriduniform.png
78    :align: center
79
80 .. centered::
81    Unfiorm cartesian grid
82
83 TUI command: :ref:`tuicartgriduniform`
84
85 .. _guicartgridcustom:
86
87 Custom cartesian grid
88 =====================
89
90 To create a Custom cartesian grid, select radio button **Custom**:
91
92 .. image:: _static/gui_make_cart_grid_custom.png
93    :align: center
94
95 .. centered::
96    Dialogue Box for a Custom cartesian grid
97
98
99 The following data are required:
100
101 - *origin*: The vertex of the origin
102 - *vec X* : The X vector
103 - *vec Y* : The Y vector
104 - *vec Z* : The Z vector
105 - *X*     : A list of x values in ascendant order
106 - *Y*     : A list of y values in ascendant order
107 - *Z*     : A list of z values in ascendant order
108
109 A value on each axis gives the length of an hexahedra on that axis from the origin of the grid.
110 For example the first value in the list of x values is the length on X axis of the first hexahedra from the origin.
111
112
113 The result of this action is:
114
115 .. image:: _static/cartgridcustom.png
116    :align: center
117
118 .. centered::
119    Custom cartesian grid
120
121 TUI command: :ref:`tuicartgridcustom`