src/SMDS/SMDS_VolumeTool.hxx

   1 // Copyright (C) 2007-2011  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, QUAD_TETRA,
  55                     QUAD_PYRAM, QUAD_PENTA, QUAD_HEXA, POLYHEDA };
  56
  57   SMDS_VolumeTool ();
  58   ~SMDS_VolumeTool ();
  59   SMDS_VolumeTool (const SMDS_MeshElement* theVolume);
  60
  61   bool Set (const SMDS_MeshElement* theVolume);
  62   // Set volume.
  63   // Return false if theVolume is not of type SMDSAbs_Volume
  64
  65   const SMDS_MeshVolume* Element() const;
  66   // return element
  67
  68   int ID() const;
  69   // return element ID
  70
  71   // -----------------------
  72   // general info
  73   // -----------------------
  74
  75   VolumeType GetVolumeType() const;
  76
  77   bool IsForward() const { return myVolForward; }
  78   // Check volume orientation. can be changed by Inverse().
  79   // See node order of forward volumes at the file bottom
  80
  81   void Inverse();
  82   // Change nodes order as if the volume changes its orientation:
  83   // top and bottom faces are reversed.
  84   // Result of IsForward() and methods returning nodes change
  85
  86   const SMDS_MeshNode** GetNodes() { return myVolumeNodes; }
  87   // Return array of volume nodes
  88
  89   int NbNodes() { return myVolumeNbNodes; }
  90   // Return array of volume nodes
  91
  92   double GetSize() const;
  93   // Return element volume
  94
  95   bool GetBaryCenter (double & X, double & Y, double & Z) const;
  96
  97   bool IsOut(double X, double Y, double Z, double tol) const;
  98   // Classify a point
  99
 100   // -----------------------
 101   // info on node connection
 102   // -----------------------
 103
 104   bool IsLinked (const SMDS_MeshNode* theNode1,
 105                  const SMDS_MeshNode* theNode2,
 106                  const bool           theIgnoreMediumNodes=false) const;
 107   // Return true if theNode1 is linked with theNode2.
 108   // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
 109
 110   bool IsLinked (const int theNode1Index,
 111                  const int theNode2Index,
 112                  bool      theIgnoreMediumNodes=false) const;
 113   // Return true if the node with theNode1Index is linked
 114   // with the node with theNode2Index
 115   // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
 116
 117   int GetNodeIndex(const SMDS_MeshNode* theNode) const;
 118   // Return an index of theNode
 119
 120   int GetAllExistingEdges(std::vector<const SMDS_MeshElement*> & edges) const;
 121   // Fill vector with boundary edges existing in the mesh
 122
 123   double MinLinearSize2() const;
 124   // Return minimal square distance between connected corner nodes
 125
 126   // -------------
 127   // info on faces
 128   // -------------
 129
 130   void SetExternalNormal ();
 131   // Node order in faces  will be so that faces normals are external.
 132
 133   int NbFaces() const { return myNbFaces; }
 134   // Return number of faces of the volume. In the following
 135   // methods 0 <= faceIndex < NbFaces()
 136
 137   int NbFaceNodes( int faceIndex ) const;
 138   // Return number of nodes in the array of face nodes
 139
 140   const int* GetFaceNodesIndices( int faceIndex ) const;
 141   // Return the array of face nodes indices
 142   // To comfort link iteration, the array
 143   // length == NbFaceNodes( faceIndex ) + 1 and
 144   // the last node index == the first one.
 145   // NOTE: for the quadratic volume, node indoces are in the order the nodes encounter
 146   // in face boundary and not the order they are in the mesh face
 147
 148   const SMDS_MeshNode** GetFaceNodes( int faceIndex ) const;
 149   // Return the array of face nodes.
 150   // To comfort link iteration, the array
 151   // length == NbFaceNodes( faceIndex ) + 1 and
 152   // the last node == the first one.
 153   // NOTE: for the quadratic volume, nodes are in the order they encounter in face boundary
 154   // and not the order they are in the mesh face
 155   // WARNING: do not modify the array, some methods
 156   //          work basing on its contents
 157
 158   bool GetFaceNodes (int faceIndex,
 159                      std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
 160   // Return a set of face nodes.
 161
 162   bool IsFaceExternal( int faceIndex ) const;
 163   // Check normal orientation of a face.
 164   // SetExternalNormal() is taken into account.
 165
 166   bool IsFreeFace(  int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
 167   // Check that all volumes built on the face nodes lays on one side
 168   // otherVol returns another volume sharing the given facet
 169
 170   bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z) const;
 171   // Return a normal to a face
 172
 173   bool GetFaceBaryCenter (int faceIndex, double & X, double & Y, double & Z) const;
 174   // Return barycenter of a face
 175
 176   double GetFaceArea( int faceIndex ) const;
 177   // Return face area
 178
 179   int GetOppFaceIndex( int faceIndex ) const;
 180   // Return index of the opposite face if it exists, else -1.
 181
 182   int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
 183   // Return index of a face formed by theFaceNodes.
 184   // Return -1 if a face not found
 185
 186   //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
 187   // Return index of a face formed by theFaceNodesIndices
 188   // Return -1 if a face not found
 189
 190   int GetAllExistingFaces(std::vector<const SMDS_MeshElement*> & faces) const;
 191   // Fill vector with boundary faces existing in the mesh
 192
 193   // ------------------------
 194   // static methods for faces
 195   // ------------------------
 196
 197   static VolumeType GetType(int nbNodes);
 198   // return VolumeType by nb of nodes in a volume
 199
 200   static int NbFaces( VolumeType type );
 201   // return nb of faces by volume type
 202
 203   static const int* GetFaceNodesIndices(VolumeType type,
 204                                         int        faceIndex,
 205                                         bool       external);
 206   // Return the array of face nodes indices
 207   // To comfort link iteration, the array
 208   // length == NbFaceNodes( faceIndex ) + 1 and
 209   // the last node index == the first one.
 210
 211   static int NbFaceNodes(VolumeType type,
 212                          int        faceIndex );
 213   // Return number of nodes in the array of face nodes
 214
 215   static int NbCornerNodes(VolumeType type);
 216   // Useful to know nb of corner nodes of a quadratic volume
 217
 218 private:
 219
 220   bool setFace( int faceIndex ) const;
 221
 222   const SMDS_MeshElement* myVolume;
 223   const SMDS_VtkVolume*   myPolyedre;
 224
 225   bool                    myVolForward;
 226   int                     myNbFaces;
 227   int                     myVolumeNbNodes;
 228   const SMDS_MeshNode**   myVolumeNodes;
 229   std::vector< int >      myPolyIndices;
 230
 231   mutable bool                    myExternalFaces;
 232
 233   mutable int                     myCurFace;
 234   mutable int                     myFaceNbNodes;
 235   mutable int*                    myFaceNodeIndices;
 236   mutable const SMDS_MeshNode**   myFaceNodes;
 237
 238 };
 239 #endif
 240
 241
 242 ///////////////////////////////////////////////////////////////////////////
 243 //
 244 //                   ORDER OF NODES OF FORWARD ELEMENT
 245 //
 246 ///////////////////////////////////////////////////////////////////////////
 247 /*
 248 //           N3
 249 //           +
 250 //          /|\
 251 //         / | \
 252 //        /  |  \
 253 //    N0 +---|---+ N1                TETRAHEDRON
 254 //       \   |   /
 255 //        \  |  /
 256 //         \ | /
 257 //          \|/
 258 //           +
 259 //           N2
 260
 261 //            + N4
 262 //           /|\
 263 //          / | \
 264 //         /  |  \
 265 //        /   |   \
 266 //    N3 +---------+ N5
 267 //       |    |    |
 268 //       |    + N1 |
 269 //       |   / \   |                PENTAHEDRON
 270 //       |  /   \  |
 271 //       | /     \ |
 272 //       |/       \|
 273 //    N0 +---------+ N2
 274
 275 //         N5+----------+N6
 276 //          /|         /|
 277 //         / |        / |
 278 //        /  |       /  |
 279 //     N4+----------+N7 |
 280 //       |   |      |   |           HEXAHEDRON
 281 //       |   |      |   |
 282 //       |   |      |   |
 283 //       | N1+------|---+N2
 284 //       |  /       |  /
 285 //       | /        | /
 286 //       |/         |/
 287 //     N0+----------+N3
 288 //
 289 */