src/SMDS/SMDS_VolumeTool.hxx

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  SMESH SMDS : implementaion of Salome mesh data structure
  24 // File      : SMDS_VolumeTool.hxx
  25 // Module    : SMESH
  26 // Created   : Tue Jul 13 11:27:17 2004
  27 // Author    : Edward AGAPOV (eap)
  28 //
  29 #ifndef SMDS_VolumeTool_HeaderFile
  30 #define SMDS_VolumeTool_HeaderFile
  31
  32 #include "SMESH_SMDS.hxx"
  33
  34 class SMDS_MeshElement;
  35 class SMDS_MeshNode;
  36 class SMDS_VtkVolume;
  37 class SMDS_MeshVolume;
  38
  39 #include <vector>
  40 #include <set>
  41
  42 // =========================================================================
  43 //
  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.
  47 //
  48 // =========================================================================
  49
  50 class SMDS_EXPORT SMDS_VolumeTool
  51 {
  52  public:
  53
  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()!
  57
  58   SMDS_VolumeTool ();
  59   ~SMDS_VolumeTool ();
  60   SMDS_VolumeTool (const SMDS_MeshElement* theVolume,
  61                    const bool              ignoreCentralNodes=true);
  62
  63   bool Set (const SMDS_MeshElement* theVolume,
  64             const bool              ignoreCentralNodes=true);
  65   // Set volume.
  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
  69
  70   const SMDS_MeshVolume* Element() const;
  71   // return element
  72
  73   int ID() const;
  74   // return element ID
  75
  76   // -----------------------
  77   // general info
  78   // -----------------------
  79
  80   VolumeType GetVolumeType() const;
  81
  82   bool IsForward() const { return myVolForward; }
  83   // Check volume orientation. can be changed by Inverse().
  84   // See node order of forward volumes at the file bottom
  85
  86   void Inverse();
  87   // Change nodes order as if the volume changes its orientation:
  88   // top and bottom faces are reversed.
  89   // Result of IsForward() and methods returning nodes change
  90
  91   const SMDS_MeshNode** GetNodes() { return myVolumeNodes; }
  92   // Return array of volume nodes
  93
  94   int NbNodes() { return myVolumeNbNodes; }
  95   // Return array of volume nodes
  96
  97   double GetSize() const;
  98   // Return element volume
  99
 100   bool GetBaryCenter (double & X, double & Y, double & Z) const;
 101
 102   bool IsOut(double X, double Y, double Z, double tol) const;
 103   // Classify a point
 104
 105   // -----------------------
 106   // info on node connection
 107   // -----------------------
 108
 109   bool IsLinked (const SMDS_MeshNode* theNode1,
 110                  const SMDS_MeshNode* theNode2,
 111                  const bool           theIgnoreMediumNodes=false) const;
 112   // Return true if theNode1 is linked with theNode2.
 113   // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
 114
 115   bool IsLinked (const int theNode1Index,
 116                  const int theNode2Index,
 117                  bool      theIgnoreMediumNodes=false) const;
 118   // Return true if the node with theNode1Index is linked
 119   // with the node with theNode2Index
 120   // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
 121
 122   int GetNodeIndex(const SMDS_MeshNode* theNode) const;
 123   // Return an index of theNode
 124
 125   int GetAllExistingEdges(std::vector<const SMDS_MeshElement*> & edges) const;
 126   // Fill vector with boundary edges existing in the mesh
 127
 128   double MinLinearSize2() const;
 129   // Return minimal square distance between connected corner nodes
 130
 131   double MaxLinearSize2() const;
 132   // Return maximal square distance between connected corner nodes
 133
 134   // -------------
 135   // info on faces
 136   // -------------
 137   // For all elements, 0-th face is bottom based on the first nodes.
 138   // For prismatic elements (tetra,hexa,prisms), 1-th face is a top one.
 139   // For all elements, side faces follow order of bottom nodes
 140
 141   void SetExternalNormal ();
 142   // Node order in faces  will be so that faces normals are external.
 143
 144   int NbFaces() const { return myNbFaces; }
 145   // Return number of faces of the volume. In the following
 146   // methods 0 <= faceIndex < NbFaces()
 147
 148   int NbFaceNodes( int faceIndex ) const;
 149   // Return number of nodes in the array of face nodes
 150
 151   const int* GetFaceNodesIndices( int faceIndex ) const;
 152   // Return the array of face nodes indices
 153   // To comfort link iteration, the array
 154   // length == NbFaceNodes( faceIndex ) + 1 and
 155   // the last node index == the first one, except for
 156   // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
 157   // NOTE: for the quadratic volume, node indices are in the order the nodes encounter
 158   // in face boundary and not the order they are in the mesh face
 159
 160   const SMDS_MeshNode** GetFaceNodes( int faceIndex ) const;
 161   // Return the array of face nodes.
 162   // To comfort link iteration, the array
 163   // length == NbFaceNodes( faceIndex ) + 1 and
 164   // the last node == the first one, except for
 165   // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
 166   // NOTE: for the quadratic volume, nodes are in the order they encounter in face boundary
 167   // and not the order they are in the mesh face
 168   // WARNING: do not modify the array, some methods
 169   //          work basing on its contents
 170
 171   bool GetFaceNodes (int faceIndex,
 172                      std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
 173   // Return a set of face nodes.
 174
 175   bool IsFaceExternal( int faceIndex ) const;
 176   // Check normal orientation of a face.
 177   // SetExternalNormal() is taken into account.
 178
 179   bool IsFreeFace(  int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
 180   // Check that all volumes built on the face nodes lays on one side
 181   // otherVol returns another volume sharing the given facet
 182
 183   bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z) const;
 184   // Return a normal to a face
 185
 186   bool GetFaceBaryCenter (int faceIndex, double & X, double & Y, double & Z) const;
 187   // Return barycenter of a face
 188
 189   double GetFaceArea( int faceIndex ) const;
 190   // Return face area
 191
 192   int GetOppFaceIndex( int faceIndex ) const;
 193   // Return index of the opposite face if it exists, else -1.
 194
 195   int GetCenterNodeIndex( int faceIndex ) const;
 196   // Return index of the node located at face center of a quadratic element like HEX27
 197
 198   int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
 199   // Return index of a face formed by theFaceNodes.
 200   // Return -1 if a face not found
 201
 202   //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
 203   // Return index of a face formed by theFaceNodesIndices
 204   // Return -1 if a face not found
 205
 206   int GetAllExistingFaces(std::vector<const SMDS_MeshElement*> & faces) const;
 207   // Fill vector with boundary faces existing in the mesh
 208
 209   // ------------------------
 210   // static methods for faces
 211   // ------------------------
 212
 213   static VolumeType GetType(int nbNodes);
 214   // return VolumeType by nb of nodes in a volume
 215
 216   static int NbFaces( VolumeType type );
 217   // return nb of faces by volume type
 218
 219   static const int* GetFaceNodesIndices(VolumeType type,
 220                                         int        faceIndex,
 221                                         bool       external);
 222   // Return the array of face nodes indices
 223   // To comfort link iteration, the array
 224   // length == NbFaceNodes( faceIndex ) + 1 and
 225   // the last node index == the first one.
 226   // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
 227
 228   static int NbFaceNodes(VolumeType type, int faceIndex );
 229   // Return number of nodes in the array of face nodes
 230   // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
 231
 232   static int NbCornerNodes(VolumeType type);
 233   // Useful to know nb of corner nodes of a quadratic volume
 234
 235 private:
 236
 237   bool setFace( int faceIndex ) const;
 238
 239   const SMDS_MeshElement* myVolume;
 240   const SMDS_VtkVolume*   myPolyedre;
 241   bool                    myIgnoreCentralNodes;
 242
 243   bool                    myVolForward;
 244   int                     myNbFaces;
 245   int                     myVolumeNbNodes;
 246   const SMDS_MeshNode**   myVolumeNodes;
 247   std::vector< int >      myPolyIndices;
 248
 249   mutable bool                    myExternalFaces;
 250
 251   mutable const int*              myAllFacesNodeIndices_F;
 252   mutable const int*              myAllFacesNodeIndices_RE;
 253   mutable const int*              myAllFacesNbNodes;
 254   mutable int                     myMaxFaceNbNodes;
 255
 256   mutable int                     myCurFace;
 257   mutable int                     myFaceNbNodes;
 258   mutable int*                    myFaceNodeIndices;
 259   mutable const SMDS_MeshNode**   myFaceNodes;
 260
 261 };
 262 #endif
 263
 264
 265 ///////////////////////////////////////////////////////////////////////////
 266 //
 267 //                   ORDER OF NODES OF FORWARD ELEMENT
 268 //
 269 ///////////////////////////////////////////////////////////////////////////
 270 /*
 271 //           N3
 272 //           +
 273 //          /|\
 274 //         / | \
 275 //        /  |  \
 276 //    N0 +---|---+ N1                TETRAHEDRON
 277 //       \   |   /
 278 //        \  |  /
 279 //         \ | /
 280 //          \|/
 281 //           +
 282 //           N2
 283
 284 //            + N4
 285 //           /|\
 286 //          / | \
 287 //         /  |  \
 288 //        /   |   \
 289 //    N3 +---------+ N5
 290 //       |    |    |
 291 //       |    + N1 |
 292 //       |   / \   |                PENTAHEDRON
 293 //       |  /   \  |
 294 //       | /     \ |
 295 //       |/       \|
 296 //    N0 +---------+ N2
 297
 298 //         N5+----------+N6
 299 //          /|         /|
 300 //         / |        / |
 301 //        /  |       /  |
 302 //     N4+----------+N7 |
 303 //       |   |      |   |           HEXAHEDRON
 304 //       |   |      |   |
 305 //       |   |      |   |
 306 //       | N1+------|---+N2
 307 //       |  /       |  /
 308 //       | /        | /
 309 //       |/         |/
 310 //     N0+----------+N3
 311 //
 312 */