Arcane  4.2.3.0
User documentation
Loading...
Searching...
No Matches
GeneratedGeomShapeViewDeclarations.h
1// WARNING: This file is generated by a tool. DO NOT EDIT.
2/*
3 * Generation of declarations for GeomShapeView.
4 * This file must be included directly in the definition of the GeomShapeView class.
5 */
6
7/*!
8 * \name Filling of control sub-volumes for a specific type.
9 *
10 * The geometric type (geomType()) of the instance must match the chosen method.
11 */
12//@{
13/*!
14 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
15 * \pre type()==GeomType::Triangle3
16 */
17void fillSubZoneTriangle3(Quad4ElementView svc,Integer i);
18/*!
19 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
20 * \pre type()==GeomType::Quad4
21 */
22void fillSubZoneQuad4(Quad4ElementView svc,Integer i);
23/*!
24 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
25 * \pre type()==GeomType::Pentagon5
26 */
27void fillSubZonePentagon5(Quad4ElementView svc,Integer i);
28/*!
29 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
30 * \pre type()==GeomType::Hexagon6
31 */
32void fillSubZoneHexagon6(Quad4ElementView svc,Integer i);
33/*!
34 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
35 * \pre type()==GeomType::Tetraedron4
36 */
37void fillSubZoneTetraedron4(Hexaedron8ElementView svc,Integer i);
38/*!
39 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
40 * \pre type()==GeomType::Pyramid5
41 */
42void fillSubZonePyramid5(Hexaedron8ElementView svc,Integer i);
43/*!
44 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
45 * \pre type()==GeomType::Pentaedron6
46 */
47void fillSubZonePentaedron6(Hexaedron8ElementView svc,Integer i);
48/*!
49 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
50 * \pre type()==GeomType::Hexaedron8
51 */
52void fillSubZoneHexaedron8(Hexaedron8ElementView svc,Integer i);
53/*!
54 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
55 * \pre type()==GeomType::Heptaedron10
56 */
57void fillSubZoneHeptaedron10(Hexaedron8ElementView svc,Integer i);
58/*!
59 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
60 * \pre type()==GeomType::Octaedron12
61 */
62void fillSubZoneOctaedron12(Hexaedron8ElementView svc,Integer i);
63
64//@}
65
66/*!
67 * \name Filling of control sub-volumes (obsolete methods).
68 *
69 * These methods are obsolete and must be replaced by the equivalent method
70 * with the full element name.
71 */
72//@{
73/*!
74 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
75 *
76 * \deprecated Use fillSubZoneTriangle3() instead.
77 */
78void fillSubZoneTriangle(Quad4ElementView svc,Integer i)
79{
80 fillSubZoneTriangle3(svc,i);
81}
82/*!
83 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
84 *
85 * \deprecated Use fillSubZoneQuad4() instead.
86 */
87void fillSubZoneQuad(Quad4ElementView svc,Integer i)
88{
89 fillSubZoneQuad4(svc,i);
90}
91/*!
92 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
93 *
94 * \deprecated Use fillSubZonePentagon5() instead.
95 */
96void fillSubZonePentagon(Quad4ElementView svc,Integer i)
97{
98 fillSubZonePentagon5(svc,i);
99}
100/*!
101 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
102 *
103 * \deprecated Use fillSubZoneHexagon6() instead.
104 */
105void fillSubZoneHexagon(Quad4ElementView svc,Integer i)
106{
107 fillSubZoneHexagon6(svc,i);
108}
109/*!
110 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
111 *
112 * \deprecated Use fillSubZoneTetraedron4() instead.
113 */
114void fillSubZoneTetra(Hexaedron8ElementView svc,Integer i)
115{
116 fillSubZoneTetraedron4(svc,i);
117}
118/*!
119 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
120 *
121 * \deprecated Use fillSubZonePyramid5() instead.
122 */
123void fillSubZonePyramid(Hexaedron8ElementView svc,Integer i)
124{
125 fillSubZonePyramid5(svc,i);
126}
127/*!
128 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
129 *
130 * \deprecated Use fillSubZonePentaedron6() instead.
131 */
132void fillSubZonePenta(Hexaedron8ElementView svc,Integer i)
133{
134 fillSubZonePentaedron6(svc,i);
135}
136/*!
137 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
138 *
139 * \deprecated Use fillSubZoneHexaedron8() instead.
140 */
141void fillSubZoneHexa(Hexaedron8ElementView svc,Integer i)
142{
143 fillSubZoneHexaedron8(svc,i);
144}
145/*!
146 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
147 *
148 * \deprecated Use fillSubZoneHeptaedron10() instead.
149 */
150void fillSubZoneWedge7(Hexaedron8ElementView svc,Integer i)
151{
152 fillSubZoneHeptaedron10(svc,i);
153}
154/*!
155 * \brief Fills \a svc with the information of the \a i-th control sub-volume.
156 *
157 * \deprecated Use fillSubZoneOctaedron12() instead.
158 */
159void fillSubZoneWedge8(Hexaedron8ElementView svc,Integer i)
160{
161 fillSubZoneOctaedron12(svc,i);
162}
163
164//@}
165
166/*!
167 * \brief Returns a specific view to a geometric element of type GeomType::Triangle3.
168 * \pre type()==GeomType::Triangle3
169 */
170inline Triangle3ElementConstView toTriangle3Element() const;
171/*!
172 * \brief Returns a specific view to a geometric element of type GeomType::Quad4.
173 * \pre type()==GeomType::Quad4
174 */
175inline Quad4ElementConstView toQuad4Element() const;
176/*!
177 * \brief Returns a specific view to a geometric element of type GeomType::Pentagon5.
178 * \pre type()==GeomType::Pentagon5
179 */
180inline Pentagon5ElementConstView toPentagon5Element() const;
181/*!
182 * \brief Returns a specific view to a geometric element of type GeomType::Hexagon6.
183 * \pre type()==GeomType::Hexagon6
184 */
185inline Hexagon6ElementConstView toHexagon6Element() const;
186/*!
187 * \brief Returns a specific view to a geometric element of type GeomType::Tetraedron4.
188 * \pre type()==GeomType::Tetraedron4
189 */
190inline Tetraedron4ElementConstView toTetraedron4Element() const;
191/*!
192 * \brief Returns a specific view to a geometric element of type GeomType::Pyramid5.
193 * \pre type()==GeomType::Pyramid5
194 */
195inline Pyramid5ElementConstView toPyramid5Element() const;
196/*!
197 * \brief Returns a specific view to a geometric element of type GeomType::Pentaedron6.
198 * \pre type()==GeomType::Pentaedron6
199 */
200inline Pentaedron6ElementConstView toPentaedron6Element() const;
201/*!
202 * \brief Returns a specific view to a geometric element of type GeomType::Hexaedron8.
203 * \pre type()==GeomType::Hexaedron8
204 */
205inline Hexaedron8ElementConstView toHexaedron8Element() const;
206/*!
207 * \brief Returns a specific view to a geometric element of type GeomType::Heptaedron10.
208 * \pre type()==GeomType::Heptaedron10
209 */
210inline Heptaedron10ElementConstView toHeptaedron10Element() const;
211/*!
212 * \brief Returns a specific view to a geometric element of type GeomType::Octaedron12.
213 * \pre type()==GeomType::Octaedron12
214 */
215inline Octaedron12ElementConstView toOctaedron12Element() const;
216
217
218/*!
219 * \brief Returns a specific view for a geometric shape of type GeomType::Triangle3.
220 * \pre type()==GeomType::Triangle3
221 */
222inline Triangle3ShapeView toTriangle3Shape() const;
223/*!
224 * \brief Returns a specific view for a geometric shape of type GeomType::Quad4.
225 * \pre type()==GeomType::Quad4
226 */
227inline Quad4ShapeView toQuad4Shape() const;
228/*!
229 * \brief Returns a specific view for a geometric shape of type GeomType::Pentagon5.
230 * \pre type()==GeomType::Pentagon5
231 */
232inline Pentagon5ShapeView toPentagon5Shape() const;
233/*!
234 * \brief Returns a specific view for a geometric shape of type GeomType::Hexagon6.
235 * \pre type()==GeomType::Hexagon6
236 */
237inline Hexagon6ShapeView toHexagon6Shape() const;
238/*!
239 * \brief Returns a specific view for a geometric shape of type GeomType::Tetraedron4.
240 * \pre type()==GeomType::Tetraedron4
241 */
242inline Tetraedron4ShapeView toTetraedron4Shape() const;
243/*!
244 * \brief Returns a specific view for a geometric shape of type GeomType::Pyramid5.
245 * \pre type()==GeomType::Pyramid5
246 */
247inline Pyramid5ShapeView toPyramid5Shape() const;
248/*!
249 * \brief Returns a specific view for a geometric shape of type GeomType::Pentaedron6.
250 * \pre type()==GeomType::Pentaedron6
251 */
252inline Pentaedron6ShapeView toPentaedron6Shape() const;
253/*!
254 * \brief Returns a specific view for a geometric shape of type GeomType::Hexaedron8.
255 * \pre type()==GeomType::Hexaedron8
256 */
257inline Hexaedron8ShapeView toHexaedron8Shape() const;
258/*!
259 * \brief Returns a specific view for a geometric shape of type GeomType::Heptaedron10.
260 * \pre type()==GeomType::Heptaedron10
261 */
262inline Heptaedron10ShapeView toHeptaedron10Shape() const;
263/*!
264 * \brief Returns a specific view for a geometric shape of type GeomType::Octaedron12.
265 * \pre type()==GeomType::Octaedron12
266 */
267inline Octaedron12ShapeView toOctaedron12Shape() const;
268
Constant view on geometric elements of type GeomType::Heptaedron10.
Specific view on geometric shapes of type GeomType::Heptaedron10.
Constant view on geometric elements of type GeomType::Hexaedron8.
Modifiable view on geometric elements of type GeomType::Hexaedron8.
Specific view on geometric shapes of type GeomType::Hexaedron8.
Constant view on geometric elements of type GeomType::Hexagon6.
Specific view on geometric shapes of type GeomType::Hexagon6.
Constant view on geometric elements of type GeomType::Octaedron12.
Specific view on geometric shapes of type GeomType::Octaedron12.
Constant view on geometric elements of type GeomType::Pentaedron6.
Specific view on geometric shapes of type GeomType::Pentaedron6.
Constant view on geometric elements of type GeomType::Pentagon5.
Specific view on geometric shapes of type GeomType::Pentagon5.
Constant view on geometric elements of type GeomType::Pyramid5.
Specific view on geometric shapes of type GeomType::Pyramid5.
Constant view on geometric elements of type GeomType::Quad4.
Modifiable view on geometric elements of type GeomType::Quad4.
Specific view on geometric shapes of type GeomType::Quad4.
Constant view on geometric elements of type GeomType::Tetraedron4.
Specific view on geometric shapes of type GeomType::Tetraedron4.
Constant view on geometric elements of type GeomType::Triangle3.
Specific view on geometric shapes of type GeomType::Triangle3.