src/SMDS/SMDS_VolumeTool.hxx

   1 //  Copyright (C) 2007-2010  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_PolyhedralVolumeOfNodes;
  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);
  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   // -------------
 124   // info on faces
 125   // -------------
 126
 127   void SetExternalNormal ();
 128   // Node order in faces  will be so that faces normals are external.
 129
 130   int NbFaces() const { return myNbFaces; }
 131   // Return number of faces of the volume. In the following
 132   // methods 0 <= faceIndex < NbFaces()
 133
 134   int NbFaceNodes( int faceIndex );
 135   // Return number of nodes in the array of face nodes
 136
 137   const int* GetFaceNodesIndices( int faceIndex );
 138   // Return the array of face nodes indices
 139   // To comfort link iteration, the array
 140   // length == NbFaceNodes( faceIndex ) + 1 and
 141   // the last node index == the first one.
 142
 143   const SMDS_MeshNode** GetFaceNodes( int faceIndex );
 144   // Return the array of face nodes.
 145   // To comfort link iteration, the array
 146   // length == NbFaceNodes( faceIndex ) + 1 and
 147   // the last node == the first one.
 148   // WARNING: do not modify the array, some methods
 149   //          work basing on its contents
 150
 151   bool GetFaceNodes (int faceIndex,
 152                      std::set<const SMDS_MeshNode*>& theFaceNodes );
 153   // Return a set of face nodes.
 154
 155   bool IsFaceExternal( int faceIndex );
 156   // Check normal orientation of a face.
 157   // SetExternalNormal() is taken into account.
 158
 159   bool IsFreeFace(  int faceIndex );
 160   // Check that all volumes built on the face nodes lays on one side
 161
 162   bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z);
 163   // Return a normal to a face
 164
 165   double GetFaceArea( int faceIndex );
 166   // Return face area
 167
 168   int GetOppFaceIndex( int faceIndex ) const;
 169   // Return index of the opposite face if it exists, else -1.
 170
 171   int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes );
 172   // Return index of a face formed by theFaceNodes.
 173   // Return -1 if a face not found
 174
 175   //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
 176   // Return index of a face formed by theFaceNodesIndices
 177   // Return -1 if a face not found
 178
 179   int GetAllExistingFaces(std::vector<const SMDS_MeshElement*> & faces);
 180   // Fill vector with boundary faces existing in the mesh
 181
 182   // ------------------------
 183   // static methods for faces
 184   // ------------------------
 185
 186   static VolumeType GetType(int nbNodes);
 187   // return VolumeType by nb of nodes in a volume
 188
 189   static int NbFaces( VolumeType type );
 190   // return nb of faces by volume type
 191
 192   static const int* GetFaceNodesIndices(VolumeType type,
 193                                         int        faceIndex,
 194                                         bool       external);
 195   // Return the array of face nodes indices
 196   // To comfort link iteration, the array
 197   // length == NbFaceNodes( faceIndex ) + 1 and
 198   // the last node index == the first one.
 199
 200   static int NbFaceNodes(VolumeType type,
 201                          int        faceIndex );
 202   // Return number of nodes in the array of face nodes
 203
 204   static int NbCornerNodes(VolumeType type);
 205   // Useful to know nb of corner nodes of a quadratic volume
 206
 207 private:
 208
 209   bool setFace( int faceIndex );
 210
 211   const SMDS_MeshElement* myVolume;
 212   const SMDS_PolyhedralVolumeOfNodes* myPolyedre;
 213
 214   bool                    myVolForward;
 215   int                     myNbFaces;
 216   int                     myVolumeNbNodes;
 217   const SMDS_MeshNode**   myVolumeNodes;
 218   std::vector< int >      myPolyIndices;
 219
 220   bool                    myExternalFaces;
 221
 222   int                     myCurFace;
 223   int                     myFaceNbNodes;
 224   int*                    myFaceNodeIndices;
 225   const SMDS_MeshNode**   myFaceNodes;
 226
 227 };
 228 #endif
 229
 230
 231 ///////////////////////////////////////////////////////////////////////////
 232 //
 233 //                   ORDER OF NODES OF FORWARD ELEMENT
 234 //
 235 ///////////////////////////////////////////////////////////////////////////
 236 /*
 237 //           N3
 238 //           +
 239 //          /|\
 240 //         / | \
 241 //        /  |  \
 242 //    N0 +---|---+ N1                TETRAHEDRON
 243 //       \   |   /
 244 //        \  |  /
 245 //         \ | /
 246 //          \|/
 247 //           +
 248 //           N2
 249
 250 //            + N4
 251 //           /|\
 252 //          / | \
 253 //         /  |  \
 254 //        /   |   \
 255 //    N3 +---------+ N5
 256 //       |    |    |
 257 //       |    + N1 |
 258 //       |   / \   |                PENTAHEDRON
 259 //       |  /   \  |
 260 //       | /     \ |
 261 //       |/       \|
 262 //    N0 +---------+ N2
 263
 264 //         N5+----------+N6
 265 //          /|         /|
 266 //         / |        / |
 267 //        /  |       /  |
 268 //     N4+----------+N7 |
 269 //       |   |      |   |           HEXAHEDRON
 270 //       |   |      |   |
 271 //       |   |      |   |
 272 //       | N1+------|---+N2
 273 //       |  /       |  /
 274 //       | /        | /
 275 //       |/         |/
 276 //     N0+----------+N3
 277 //
 278 */