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