1 // Copyright (C) 2007-2024 CEA, EDF, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SMESH SMDS : implementation of Salome mesh data structure
24 // File : SMDS_VolumeTool.hxx
26 // Created : Tue Jul 13 11:27:17 2004
27 // Author : Edward AGAPOV (eap)
29 #ifndef SMDS_VolumeTool_HeaderFile
30 #define SMDS_VolumeTool_HeaderFile
32 #include "SMESH_SMDS.hxx"
34 #include <smIdType.hxx>
36 class SMDS_MeshElement;
38 class SMDS_MeshVolume;
44 // =========================================================================
46 // Class providing topological and other information about SMDS_MeshVolume:
47 // allows iteration on faces or, to be precise, on nodes of volume sides;
48 // provides info on nodes connection etc.
50 // =========================================================================
52 class SMDS_EXPORT SMDS_VolumeTool
56 enum VolumeType { UNKNOWN = -1, TETRA = 0, PYRAM, PENTA, HEXA,
57 HEX_PRISM, QUAD_TETRA, QUAD_PYRAM, QUAD_PENTA, QUAD_HEXA,
58 POLYHEDA, NB_VOLUME_TYPES }; // to keep synchronised with GetSize()!
62 SMDS_VolumeTool( const SMDS_MeshElement* theVolume,
63 const bool ignoreCentralNodes = true);
65 bool Set( const SMDS_MeshElement* theVolume,
66 const bool ignoreCentralNodes = true,
67 const std::vector<const SMDS_MeshNode*>* nodes = 0);
69 // Return false if theVolume is not of type SMDSAbs_Volume.
70 // ignoreCentralNodes makes skip nodes at face centers when returning
71 // nodes of faces of SMDSEntity_TriQuad_Hexa.
72 // alternative nodes can be provided
74 const SMDS_MeshVolume* Element() const;
80 bool IsPoly() const { return myPolyedre; }
82 // -----------------------
84 // -----------------------
86 VolumeType GetVolumeType() const;
88 bool IsForward() const { return myVolForward; }
89 // Check volume orientation. can be changed by Inverse().
90 // See node order of forward volumes at the file bottom
93 // Change nodes order as if the volume changes its orientation:
94 // top and bottom faces are reversed.
95 // Result of IsForward() and methods returning nodes change
97 const SMDS_MeshNode** GetNodes() const { return (const SMDS_MeshNode**) &myVolumeNodes[0]; }
98 // Return array of volume nodes
100 int NbNodes() const { return (int) myVolumeNodes.size(); }
101 // Return number of volume nodes
103 double GetSize() const;
104 // Return element volume
106 double GetScaledJacobian() const;
107 // Return the scaled jacobian
109 bool GetBaryCenter (double & X, double & Y, double & Z) const;
111 bool IsOut(double X, double Y, double Z, double tol) const;
114 // -----------------------
115 // info on node connection
116 // -----------------------
118 bool IsLinked (const SMDS_MeshNode* theNode1,
119 const SMDS_MeshNode* theNode2,
120 const bool theIgnoreMediumNodes=false) const;
121 // Return true if theNode1 is linked with theNode2.
122 // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
124 bool IsLinked (const int theNode1Index,
125 const int theNode2Index,
126 bool theIgnoreMediumNodes=false) const;
127 // Return true if the node with theNode1Index is linked
128 // with the node with theNode2Index
129 // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
131 int GetNodeIndex(const SMDS_MeshNode* theNode) const;
132 // Return an index of theNode
134 int GetAllExistingEdges(std::vector<const SMDS_MeshElement*> & edges) const;
135 // Fill vector with boundary edges existing in the mesh
137 double MinLinearSize2() const;
138 // Return minimal square distance between connected corner nodes
140 double MaxLinearSize2() const;
141 // Return maximal square distance between connected corner nodes
146 // For all elements, 0-th face is bottom based on the first nodes.
147 // For prismatic elements (tetra,hexa,prisms), 1-th face is a top one.
148 // For all elements, side faces follow order of bottom nodes
150 void SetExternalNormal ();
151 // Node order in faces will be so that faces normals are external.
153 int NbFaces() const { return myNbFaces; }
154 // Return number of faces of the volume. In the following
155 // methods 0 <= faceIndex < NbFaces()
157 int NbFaceNodes( int faceIndex ) const;
158 // Return number of nodes in the array of face nodes
160 const int* GetFaceNodesIndices( int faceIndex ) const;
161 // Return the array of face nodes indices
162 // To comfort link iteration, the array
163 // length == NbFaceNodes( faceIndex ) + 1 and
164 // the last node index == the first one, except for
165 // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
166 // NOTE: for the quadratic volume, node indices are in the order the nodes encounter
167 // in face boundary and not the order they are in the mesh face
169 const SMDS_MeshNode** GetFaceNodes( int faceIndex ) const;
170 // Return the array of face nodes.
171 // To comfort link iteration, the array
172 // length == NbFaceNodes( faceIndex ) + 1 and
173 // the last node == the first one, except for
174 // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
175 // NOTE: for the quadratic volume, nodes are in the order they encounter in face boundary
176 // and not the order they are in the mesh face
177 // WARNING: do not modify the array, some methods
178 // work basing on its contents
180 bool GetFaceNodes (int faceIndex,
181 std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
182 // Return a set of face nodes.
184 bool IsFaceExternal( int faceIndex ) const;
185 // Check normal orientation of a face.
186 // SetExternalNormal() is taken into account.
188 bool IsFreeFace( int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
189 // Fast check that only one volume is built on nodes of a given face
190 // otherVol returns another volume sharing the given facet
191 // Function works for conforming mesh.
193 bool IsFreeFaceCheckAllNodes( int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
194 // Check that only one volume is built on nodes of a given face
195 // otherVol returns another volume sharing the given facet
196 // Function to be used on mesh with non conforming elements. The face shared between
198 bool IsFreeFaceAdv( int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
199 // Thorough check that all volumes built on the face nodes lays on one side
200 // otherVol returns another volume sharing the given facet
202 bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z) const;
203 // Return a normal to a face
205 bool GetFaceBaryCenter (int faceIndex, double & X, double & Y, double & Z) const;
206 // Return barycenter of a face
208 bool AllFacesSameOriented() const;
209 // Check that all the faces of a polyhedron have the same orientation
210 // no differentiation between inward and outward orientation is made.
212 double GetFaceArea( int faceIndex ) const;
215 int GetOppFaceIndex( int faceIndex ) const;
216 // Return index of the opposite face if it exists, else -1.
218 int GetCenterNodeIndex( int faceIndex ) const;
219 // Return index of the node located at face center of a quadratic element like HEX27
221 int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes,
222 const int theFaceIndexHint=-1) const;
223 // Return index of a face formed by theFaceNodes.
224 // Return -1 if a face not found
226 //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
227 // Return index of a face formed by theFaceNodesIndices
228 // Return -1 if a face not found
230 int GetAllExistingFaces(std::vector<const SMDS_MeshElement*> & faces) const;
231 // Fill vector with boundary faces existing in the mesh
233 // ------------------------
234 // static methods for faces
235 // ------------------------
237 static VolumeType GetType(int nbNodes);
238 // return VolumeType by nb of nodes in a volume
240 static int NbFaces( VolumeType type );
241 // return nb of faces by volume type
243 static const int* GetFaceNodesIndices(VolumeType type,
246 // Return the array of face nodes indices
247 // To comfort link iteration, the array
248 // length == NbFaceNodes( faceIndex ) + 1 and
249 // the last node index == the first one.
250 // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
252 static int NbFaceNodes(VolumeType type, int faceIndex );
253 // Return number of nodes in the array of face nodes
254 // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
256 static int NbCornerNodes(VolumeType type);
257 // Useful to know nb of corner nodes of a quadratic volume
259 static int GetOppFaceIndexOfHex( int faceIndex );
260 // Return index of the opposite face of the hexahedron
264 bool setFace( int faceIndex ) const;
266 bool projectNodesToNormal( int faceIndex,
269 double* normal = 0) const;
271 const SMDS_MeshElement* myVolume;
272 const SMDS_MeshVolume* myPolyedre;
273 bool myIgnoreCentralNodes;
277 std::vector<const SMDS_MeshNode*> myVolumeNodes;
278 std::vector< int > myPolyIndices; // of a myCurFace
279 std::vector<int> myPolyQuantities;
280 std::vector< int > myPolyFacetOri; // -1-in, +1-out, 0-undef
282 typedef std::pair<int,int> Link;
283 std::map<Link, int> myFwdLinks; // used in IsFaceExternal() to find out myPolyFacetOri
285 mutable bool myExternalFaces;
287 mutable const int* myAllFacesNodeIndices_F;
288 mutable const int* myAllFacesNodeIndices_RE;
289 mutable const int* myAllFacesNbNodes;
290 mutable int myMaxFaceNbNodes;
298 std::vector<const SMDS_MeshNode*> myNodes;
300 mutable Facet myCurFace;
306 ///////////////////////////////////////////////////////////////////////////
308 // ORDER OF NODES OF FORWARD ELEMENT
310 ///////////////////////////////////////////////////////////////////////////
317 // N0 +---|---+ N1 TETRAHEDRON
333 // | / \ | PENTAHEDRON
343 // N4+----------+N7 |
344 // | | | | HEXAHEDRON
347 // | N1+------|---+N2