1 .. _tui_create_boundary:
6 .. index:: single: boundary
7 .. index:: single: cylinder
8 .. index:: single: sphere
10 The variables are described in :doc:`gui_create_boundary`.
12 Methods of the class homard
13 ***************************
14 These methods returns an instance of the class boundary.
16 +----------------------------------------------------------------------------------------+
17 +----------------------------------------------------------------------------------------+
18 | .. module:: CreateBoundaryDi |
20 | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)** |
21 | Returns an instance of the class ``boundary``, type discrete after its creation |
23 | - ``boundary_name``: the name of the discrete boundary |
24 | - ``mesh_name``: the name of the mesh of the boundary |
25 | - ``mesh_file``: the name of the file for this mesh |
26 +----------------------------------------------------------------------------------------+
27 | .. module:: CreateBoundaryCylinder |
29 | **CreateBoundaryCylinder(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)** |
30 | Returns an instance of the class ``boundary`` analytical type cylindrical |
31 | after its creation |
33 | - ``boundary_name``: the name of the analytical boundary based on a cylinder |
34 | - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of a point on the axis of the cylinder |
35 | - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis |
36 | - ``R``: radius of the cylinder |
37 +----------------------------------------------------------------------------------------+
38 | .. module:: CreateBoundarySphere |
40 | **CreateBoundarySphere(boundary_name, Xcen, Ycen, Zcen, R)** |
41 | Returns an instance of the class ``boundary`` analytical type spherical |
42 | after its creation |
44 | - ``boundary_name``: the name of the boundary analytique based on a sphere |
45 | - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the sphere |
46 | - ``R``: radius of the sphere |
47 +----------------------------------------------------------------------------------------+
48 | .. module:: CreateBoundaryConeA |
50 | **CreateBoundaryConeA(boundary_name, Xaxe, Yaxe, Zaxe, Angle, Xcen, Ycen, Zcen)** |
51 | Returns an instance of the class ``boundary`` analytical type conical |
52 | after its creation |
54 | - ``boundary_name``: the name of the boundary analytique based on a cone |
55 | - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis |
56 | - ``Angle``: opening angle of the cone in degree (between 0 and 90) |
57 | - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the cone |
58 +----------------------------------------------------------------------------------------+
59 | .. module:: CreateBoundaryConeR |
61 | **CreateBoundaryConeR(boundary_name, Xc1, Yc1, Zc1, R1, Xc2, Yc2, Zc2, R2)** |
62 | Returns an instance of the class ``boundary`` analytical type conical |
63 | after its creation |
65 | - ``boundary_name``: the name of the boundary analytique based on a cone |
66 | - ``Xc1``, ``Yc1``, ``Zc1``: coordinates of the first centre of the cone |
67 | - ``R1``: radius of the cone at the first centre of the cone |
68 | - ``Xc2``, ``Yc2``, ``Zc2``: coordinates of the second centre of the cone |
69 | - ``R2``: radius of the cone at the second centre of the cone |
70 +----------------------------------------------------------------------------------------+
71 | .. module:: CreateBoundaryTorus |
73 | **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
74 | Returns an instance of the class ``boundary`` analytical type torus |
75 | after its creation |
77 | - ``boundary_name``: the name of the analytical boundary based on a torus |
78 | - ``Xcen``, ``Ycen``, ``Zcen``: coordinates of the centre of the torus |
79 | - ``Xaxe``, ``Yaxe``, ``Zaxe``: vector of the axis |
80 | - ``RRev``: revolution radius of the torus |
81 | - ``RPri``: primary radius of the torus |
82 +----------------------------------------------------------------------------------------+
84 +---------------------------------------------------------------+
85 +---------------------------------------------------------------+
86 | .. module:: GetBoundary |
88 | **GetBoundary(boundary_name)** |
89 | Returns the instance of the class classe ``boundary`` |
92 | - ``boundary_name``: the name of the boundary |
93 +---------------------------------------------------------------+
94 | .. module:: GetAllBoundarysName |
96 | **GetAllBoundarysName()** |
97 | Returns the list of the names of all the existing |
100 +---------------------------------------------------------------+
102 Methods of the class cas
103 ************************
104 See also in :doc:`tui_create_case`.
106 +---------------------------------------------------------------+
107 +---------------------------------------------------------------+
108 | .. module:: AddBoundaryGroup |
110 | **AddBoundaryGroup(boundary, group)** |
111 | Add a boundary to the definition of a case |
113 | - ``boundary``: name of the curved boundary |
115 | Discrete boundary: |
117 | . if all the curved lines are involved, the second |
118 | argument is an empty string. |
120 | . if only some curved lines are involved, ``group`` is |
121 | the name of the group of segments |
123 | Analytical boundary: |
125 | - ``group``: name of the groupe of faces located on the |
127 +---------------------------------------------------------------+
129 Methods of the class boundary
130 *****************************
132 +---------------------------------------------------------------+
133 +---------------------------------------------------------------+
134 | .. module:: GetName |
137 | Returns the name of the boundary |
138 +---------------------------------------------------------------+
139 | .. module:: GetType |
142 | Returns the type of the boundary: |
147 | * 3: cone defined by an axis and an angle |
148 | * 4: cone defined by 2 radius |
150 +---------------------------------------------------------------+
151 | .. module:: GetCoords |
154 | Returns the array of the coordinates of the boundary |
155 | with the same order as in its definition with |
156 | CreateBoundaryXXXX |
157 +---------------------------------------------------------------+
158 | .. module:: Delete |
161 | Deletes the boundary. |
162 | If the boundary is discrete, the file of the mesh is kept.|
164 | Returns an integer: |
165 | * 0: the destruction is done |
166 | * other value: problem |
167 +---------------------------------------------------------------+
172 Creation of a discrete boundary, a spherical boundary, and a cylindrical boundary:
175 inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
176 fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
177 fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
180 Similar graphical input
181 ***********************
182 Look at :doc:`gui_create_boundary`