1 // Copyright (C) 2007-2014 CEA/DEN, EDF R&D, 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 : implementaion 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 class SMDS_MeshElement;
37 class SMDS_MeshVolume;
42 // =========================================================================
44 // Class providing topological and other information about SMDS_MeshVolume:
45 // allows iteration on faces or, to be precise, on nodes of volume sides;
46 // provides info on nodes connection etc.
48 // =========================================================================
50 class SMDS_EXPORT SMDS_VolumeTool
54 enum VolumeType { UNKNOWN = -1, TETRA = 0, PYRAM, PENTA, HEXA,
55 HEX_PRISM, QUAD_TETRA, QUAD_PYRAM, QUAD_PENTA, QUAD_HEXA,
56 POLYHEDA, NB_VOLUME_TYPES }; // to keep synchronised with GetSize()!
60 SMDS_VolumeTool (const SMDS_MeshElement* theVolume,
61 const bool ignoreCentralNodes=true);
63 bool Set (const SMDS_MeshElement* theVolume,
64 const bool ignoreCentralNodes=true);
66 // Return false if theVolume is not of type SMDSAbs_Volume.
67 // ignoreCentralNodes makes skip nodes at face centers when returning
68 // nodes of faces of SMDSEntity_TriQuad_Hexa
70 const SMDS_MeshVolume* Element() const;
76 bool IsPoly() const { return myPolyedre; }
78 // -----------------------
80 // -----------------------
82 VolumeType GetVolumeType() const;
84 bool IsForward() const { return myVolForward; }
85 // Check volume orientation. can be changed by Inverse().
86 // See node order of forward volumes at the file bottom
89 // Change nodes order as if the volume changes its orientation:
90 // top and bottom faces are reversed.
91 // Result of IsForward() and methods returning nodes change
93 const SMDS_MeshNode** GetNodes() { return myVolumeNodes; }
94 // Return array of volume nodes
96 int NbNodes() { return myVolumeNbNodes; }
97 // Return array of volume nodes
99 double GetSize() const;
100 // Return element volume
102 bool GetBaryCenter (double & X, double & Y, double & Z) const;
104 bool IsOut(double X, double Y, double Z, double tol) const;
107 // -----------------------
108 // info on node connection
109 // -----------------------
111 bool IsLinked (const SMDS_MeshNode* theNode1,
112 const SMDS_MeshNode* theNode2,
113 const bool theIgnoreMediumNodes=false) const;
114 // Return true if theNode1 is linked with theNode2.
115 // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
117 bool IsLinked (const int theNode1Index,
118 const int theNode2Index,
119 bool theIgnoreMediumNodes=false) const;
120 // Return true if the node with theNode1Index is linked
121 // with the node with theNode2Index
122 // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
124 int GetNodeIndex(const SMDS_MeshNode* theNode) const;
125 // Return an index of theNode
127 int GetAllExistingEdges(std::vector<const SMDS_MeshElement*> & edges) const;
128 // Fill vector with boundary edges existing in the mesh
130 double MinLinearSize2() const;
131 // Return minimal square distance between connected corner nodes
133 double MaxLinearSize2() const;
134 // Return maximal square distance between connected corner nodes
139 // For all elements, 0-th face is bottom based on the first nodes.
140 // For prismatic elements (tetra,hexa,prisms), 1-th face is a top one.
141 // For all elements, side faces follow order of bottom nodes
143 void SetExternalNormal ();
144 // Node order in faces will be so that faces normals are external.
146 int NbFaces() const { return myNbFaces; }
147 // Return number of faces of the volume. In the following
148 // methods 0 <= faceIndex < NbFaces()
150 int NbFaceNodes( int faceIndex ) const;
151 // Return number of nodes in the array of face nodes
153 const int* GetFaceNodesIndices( int faceIndex ) const;
154 // Return the array of face nodes indices
155 // To comfort link iteration, the array
156 // length == NbFaceNodes( faceIndex ) + 1 and
157 // the last node index == the first one, except for
158 // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
159 // NOTE: for the quadratic volume, node indices are in the order the nodes encounter
160 // in face boundary and not the order they are in the mesh face
162 const SMDS_MeshNode** GetFaceNodes( int faceIndex ) const;
163 // Return the array of face nodes.
164 // To comfort link iteration, the array
165 // length == NbFaceNodes( faceIndex ) + 1 and
166 // the last node == the first one, except for
167 // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
168 // NOTE: for the quadratic volume, nodes are in the order they encounter in face boundary
169 // and not the order they are in the mesh face
170 // WARNING: do not modify the array, some methods
171 // work basing on its contents
173 bool GetFaceNodes (int faceIndex,
174 std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
175 // Return a set of face nodes.
177 bool IsFaceExternal( int faceIndex ) const;
178 // Check normal orientation of a face.
179 // SetExternalNormal() is taken into account.
181 bool IsFreeFace( int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
182 // Fast check that only one volume is built on nodes of a given face
183 // otherVol returns another volume sharing the given facet
185 bool IsFreeFaceAdv( int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
186 // Thorough check that all volumes built on the face nodes lays on one side
187 // otherVol returns another volume sharing the given facet
189 bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z) const;
190 // Return a normal to a face
192 bool GetFaceBaryCenter (int faceIndex, double & X, double & Y, double & Z) const;
193 // Return barycenter of a face
195 double GetFaceArea( int faceIndex ) const;
198 int GetOppFaceIndex( int faceIndex ) const;
199 // Return index of the opposite face if it exists, else -1.
201 int GetCenterNodeIndex( int faceIndex ) const;
202 // Return index of the node located at face center of a quadratic element like HEX27
204 int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes,
205 const int theFaceIndexHint=-1) const;
206 // Return index of a face formed by theFaceNodes.
207 // Return -1 if a face not found
209 //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
210 // Return index of a face formed by theFaceNodesIndices
211 // Return -1 if a face not found
213 int GetAllExistingFaces(std::vector<const SMDS_MeshElement*> & faces) const;
214 // Fill vector with boundary faces existing in the mesh
216 // ------------------------
217 // static methods for faces
218 // ------------------------
220 static VolumeType GetType(int nbNodes);
221 // return VolumeType by nb of nodes in a volume
223 static int NbFaces( VolumeType type );
224 // return nb of faces by volume type
226 static const int* GetFaceNodesIndices(VolumeType type,
229 // Return the array of face nodes indices
230 // To comfort link iteration, the array
231 // length == NbFaceNodes( faceIndex ) + 1 and
232 // the last node index == the first one.
233 // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
235 static int NbFaceNodes(VolumeType type, int faceIndex );
236 // Return number of nodes in the array of face nodes
237 // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
239 static int NbCornerNodes(VolumeType type);
240 // Useful to know nb of corner nodes of a quadratic volume
242 static int GetOppFaceIndexOfHex( int faceIndex );
243 // Return index of the opposite face of the hexahedron
247 bool setFace( int faceIndex ) const;
249 const SMDS_MeshElement* myVolume;
250 const SMDS_VtkVolume* myPolyedre;
251 bool myIgnoreCentralNodes;
256 const SMDS_MeshNode** myVolumeNodes;
257 std::vector< int > myPolyIndices;
259 mutable bool myExternalFaces;
261 mutable const int* myAllFacesNodeIndices_F;
262 mutable const int* myAllFacesNodeIndices_RE;
263 mutable const int* myAllFacesNbNodes;
264 mutable int myMaxFaceNbNodes;
266 mutable int myCurFace;
267 mutable int myFaceNbNodes;
268 mutable int* myFaceNodeIndices;
269 mutable const SMDS_MeshNode** myFaceNodes;
275 ///////////////////////////////////////////////////////////////////////////
277 // ORDER OF NODES OF FORWARD ELEMENT
279 ///////////////////////////////////////////////////////////////////////////
286 // N0 +---|---+ N1 TETRAHEDRON
302 // | / \ | PENTAHEDRON
312 // N4+----------+N7 |
313 // | | | | HEXAHEDRON
316 // | N1+------|---+N2