1 .. _tui_create_boundary:
6 .. index:: single: boundary
7 .. index:: single: frontière
8 .. index:: single: cylindre
9 .. index:: single: sphere
11 Les variables sont décrites dans :doc:`gui_create_boundary`.
13 Méthodes de la classe homard
14 ****************************
15 Ces méthodes retournent une instance de la classe boundary.
17 +----------------------------------------------------------------------------------------+
18 +----------------------------------------------------------------------------------------+
19 | .. module:: CreateBoundaryCAO |
21 | **CreateBoundaryCAO(boundary_name, xao_file)** |
22 | Retourne une instance de la classe ``boundary`` de type CAO après sa création |
24 | - ``boundary_name`` : le nom de la frontière CAO |
25 | - ``xao_file`` : le nom du fichier contenant cette CAO, au format XAO |
26 +----------------------------------------------------------------------------------------+
27 | .. module:: CreateBoundaryDi |
29 | **CreateBoundaryDi(boundary_name, mesh_name, mesh_file)** |
30 | Retourne une instance de la classe ``boundary`` de type discret après sa création |
32 | - ``boundary_name`` : le nom de la frontière discrète |
33 | - ``mesh_name`` : le nom du maillage de la frontière |
34 | - ``mesh_file`` : le nom du fichier contenant ce maillage, au format MED |
35 +----------------------------------------------------------------------------------------+
36 | .. module:: CreateBoundaryCylinder |
38 | **CreateBoundaryCylinder(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, R)** |
39 | Retourne une instance de la classe ``boundary`` analytique de type cylindrique |
42 | - ``boundary_name`` : le nom de la frontière analytique basée sur un cylindre |
43 | - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées d'un point sur l'axe du cylindre |
44 | - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe |
45 | - ``R`` : rayon du cylindre |
46 +----------------------------------------------------------------------------------------+
47 | .. module:: CreateBoundarySphere |
49 | **CreateBoundarySphere(boundary_name, Xcen, Ycen, Zcen, R)** |
50 | Retourne une instance de la classe ``boundary`` analytique de type sphérique |
53 | - ``boundary_name`` : le nom de la frontière analytique basée sur une sphere |
54 | - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre de la sphère |
55 | - ``R`` : rayon de la sphère |
56 +----------------------------------------------------------------------------------------+
57 | .. module:: CreateBoundaryConeA |
59 | **CreateBoundaryConeA(boundary_name, Xaxe, Yaxe, Zaxe, Angle, Xcen, Ycen, Zcen)** |
60 | Retourne une instance de la classe ``boundary`` analytique de type conique |
63 | - ``boundary_name`` : le nom de la frontière analytique basée sur un cône |
64 | - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe (non nécessairement normé) |
65 | - ``Angle`` : angle d'ouverture du cône en degre (entre 0 et 90) |
66 | - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du cône |
67 +----------------------------------------------------------------------------------------+
68 | .. module:: CreateBoundaryConeR |
70 | **CreateBoundaryConeR(boundary_name, Xc1, Yc1, Zc1, R1, Xc2, Yc2, Zc2, R2)** |
71 | Retourne une instance de la classe ``boundary`` analytique de type conique |
74 | - ``boundary_name`` : le nom de la frontière analytique basée sur un cône |
75 | - ``Xc1``, ``Yc1``, ``Zc1`` : coordonnées du premier centre du cône |
76 | - ``R1`` : rayon du cône à la hauteur du premier centre |
77 | - ``Xc2``, ``Yc2``, ``Zc2`` : coordonnées du second centre du cône |
78 | - ``R2`` : rayon du cône à la hauteur du second centre |
79 +----------------------------------------------------------------------------------------+
80 | .. module:: CreateBoundaryTorus |
82 | **CreateBoundaryTorus(boundary_name, Xcen, Ycen, Zcen, Xaxe, Yaxe, Zaxe, RRev, RPri)** |
83 | Retourne une instance de la classe ``boundary`` analytique de type torique |
86 | - ``boundary_name`` : le nom de la frontière analytique basée sur un tore |
87 | - ``Xcen``, ``Ycen``, ``Zcen`` : coordonnées du centre du tore |
88 | - ``Xaxe``, ``Yaxe``, ``Zaxe`` : vecteur de l'axe |
89 | - ``RRev`` : rayon de révolution du tore |
90 | - ``RPri`` : rayon primaire du tore |
91 +----------------------------------------------------------------------------------------+
93 +---------------------------------------------------------------+
94 +---------------------------------------------------------------+
95 | .. module:: GetBoundary |
97 | **GetBoundary(boundary_name)** |
98 | Retourne l'instance de la classe ``boundary`` connue par |
101 | - ``boundary_name`` : le nom de la frontière |
102 +---------------------------------------------------------------+
103 | .. module:: GetAllBoundarysName |
105 | **GetAllBoundarysName()** |
106 | Retourne la liste des noms de toutes les frontières |
109 +---------------------------------------------------------------+
111 Méthodes de la classe cas
112 *************************
113 Voir également dans :doc:`tui_create_case`.
115 +---------------------------------------------------------------+
116 +---------------------------------------------------------------+
117 | .. module:: AddBoundary |
119 | **AddBoundary(boundary)** |
120 | Ajoute une frontière à la définition du cas |
122 | - ``boundary`` : nom d'une frontière courbe à suivre |
123 +---------------------------------------------------------------+
124 | .. module:: AddBoundaryGroup |
126 | **AddBoundaryGroup(boundary, group)** |
127 | Ajoute une frontière à la définition du cas en précisant |
128 | les groupes associés |
130 | - ``boundary`` : nom d'une frontière courbe à suivre |
132 | Pour une frontière discrète ou CAO : |
134 | - ``group`` : nom d'un groupe de mailles à suivre |
136 | Pour une frontière analytique : |
138 | - ``group`` : nom d'un groupe de faces placées sur la |
140 +---------------------------------------------------------------+
142 Méthodes de la classe boundary
143 ******************************
145 +---------------------------------------------------------------+
146 +---------------------------------------------------------------+
147 | .. module:: GetName |
150 | Retourne le nom de la frontière |
151 +---------------------------------------------------------------+
152 | .. module:: GetType |
155 | Retourne le type de la frontière : |
161 | * 3 : cône défini par un axe et un angle |
162 | * 4 : cône défini par deux rayons |
164 +---------------------------------------------------------------+
165 | .. module:: GetCoords |
168 | Retourne un tableau contenant les coordonnées de la |
169 | frontière dans l'ordre d'entrée dans le CreateBoundaryXXXX|
171 +---------------------------------------------------------------+
172 | .. module:: Delete |
175 | Détruit la frontière. |
176 | Pour une frontière discrète, le fichier du maillage |
177 | associé est conservé. |
178 | Pour une frontière CAO, le fichier de la géométrie |
179 | associée est conservé. |
181 | Retourne un entier : |
182 | * 0 : destruction réussie |
183 | * autre valeur : problème |
184 +---------------------------------------------------------------+
189 Création d'une frontière CAO : ::
191 la_cao = homard.CreateBoundaryCAO("BLOC", dircase+'/tutorial_6.xao')
193 Création d'une frontière discrète, d'une frontière sphérique, puis d'une frontière cylindrique : ::
195 inter = homard.CreateBoundaryDi("INTERSECTION", 'PIQUAGE', dircase+'/tutorial_4.fr.med')
196 fron_1 = homard.CreateBoundarySphere("FRON_1", 12.3, 3.4, .56, 6.5)
197 fron_2 = homard.CreateBoundaryCylinder('CYL_1', 0.0, 25., -25., 25., 50., 75., 100.)
200 Saisie graphique correspondante
201 *******************************
202 Consulter :doc:`gui_create_boundary`