src/SMDS/SMDS_VolumeTool.hxx

   1 //  SMESH SMDS : implementaion of Salome mesh data structure
   2 //
   3 //  Copyright (C) 2003  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 //
  24 // File      : SMDS_VolumeTool.hxx
  25 // Module    : SMESH
  26 // Created   : Tue Jul 13 11:27:17 2004
  27 // Author    : Edward AGAPOV (eap)
  28
  29
  30 #ifndef SMDS_VolumeTool_HeaderFile
  31 #define SMDS_VolumeTool_HeaderFile
  32
  33 #include "SMESH_SMDS.hxx"
  34
  35 class SMDS_MeshElement;
  36 class SMDS_MeshNode;
  37 class SMDS_PolyhedralVolumeOfNodes;
  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   // -----------------------
  66   // general info
  67   // -----------------------
  68
  69   VolumeType GetVolumeType() const;
  70
  71   bool IsForward() const { return myVolForward; }
  72   // Check volume orientation. can be changed by Inverse().
  73   // See node order of forward volumes at the file bottom
  74
  75   void Inverse();
  76   // Change nodes order as if the volume changes its orientation:
  77   // top and bottom faces are reversed.
  78   // Result of IsForward() and methods returning nodes change
  79
  80   const SMDS_MeshNode** GetNodes() { return myVolumeNodes; }
  81   // Return array of volume nodes
  82
  83   int NbNodes() { return myVolumeNbNodes; }
  84   // Return array of volume nodes
  85
  86   double GetSize() const;
  87   // Return element volume
  88
  89   bool GetBaryCenter (double & X, double & Y, double & Z) const;
  90
  91
  92   // -----------------------
  93   // info on node connection
  94   // -----------------------
  95
  96   bool IsLinked (const SMDS_MeshNode* theNode1,
  97                  const SMDS_MeshNode* theNode2) const;
  98   // Return true if theNode1 is linked with theNode2.
  99
 100   bool IsLinked (const int theNode1Index,
 101                  const int theNode2Index) const;
 102   // Return true if the node with theNode1Index is linked
 103   // with the node with theNode2Index
 104
 105   int GetNodeIndex(const SMDS_MeshNode* theNode) const;
 106   // Return an index of theNode
 107
 108   // -------------
 109   // info on faces
 110   // -------------
 111
 112   void SetExternalNormal ();
 113   // Node order in faces  will be so that faces normals are external.
 114
 115   int NbFaces() const { return myNbFaces; }
 116   // Return number of faces of the volume. In the following
 117   // methods 0 <= faceIndex < NbFaces()
 118
 119   int NbFaceNodes( int faceIndex );
 120   // Return number of nodes in the array of face nodes
 121
 122   const int* GetFaceNodesIndices( int faceIndex );
 123   // Return the array of face nodes indices
 124   // To comfort link iteration, the array
 125   // length == NbFaceNodes( faceIndex ) + 1 and
 126   // the last node index == the first one.
 127
 128   const SMDS_MeshNode** GetFaceNodes( int faceIndex );
 129   // Return the array of face nodes.
 130   // To comfort link iteration, the array
 131   // length == NbFaceNodes( faceIndex ) + 1 and
 132   // the last node == the first one.
 133   // WARNING: do not modify the array, some methods
 134   //          work basing on its contents
 135
 136   bool GetFaceNodes (int faceIndex,
 137                      std::set<const SMDS_MeshNode*>& theFaceNodes );
 138   // Return a set of face nodes.
 139
 140   bool IsFaceExternal( int faceIndex );
 141   // Check normal orientation of a face.
 142   // SetExternalNormal() is taken into account.
 143
 144   bool IsFreeFace(  int faceIndex );
 145   // Check that all volumes built on the face nodes lays on one side
 146
 147   bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z);
 148   // Return a normal to a face
 149
 150   double GetFaceArea( int faceIndex );
 151   // Return face area
 152
 153   int GetOppFaceIndex( int faceIndex ) const;
 154   // Return index of the opposite face if it exists, else -1.
 155
 156   int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes );
 157   // Return index of a face formed by theFaceNodes.
 158   // Return -1 if a face not found
 159
 160   //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
 161   // Return index of a face formed by theFaceNodesIndices
 162   // Return -1 if a face not found
 163
 164   // ------------------------
 165   // static methods for faces
 166   // ------------------------
 167
 168   static VolumeType GetType(int nbNodes);
 169   // return VolumeType by nb of nodes in a volume
 170
 171   static int NbFaces( VolumeType type );
 172   // return nb of faces by volume type
 173
 174   static const int* GetFaceNodesIndices(VolumeType type,
 175                                         int        faceIndex,
 176                                         bool       external);
 177   // Return the array of face nodes indices
 178   // To comfort link iteration, the array
 179   // length == NbFaceNodes( faceIndex ) + 1 and
 180   // the last node index == the first one.
 181
 182   static int NbFaceNodes(VolumeType type,
 183                          int        faceIndex );
 184   // Return number of nodes in the array of face nodes
 185
 186   static int NbCornerNodes(VolumeType type);
 187   // Useful to know nb of corner nodes of a quadratic volume
 188
 189 private:
 190
 191   bool setFace( int faceIndex );
 192
 193   const SMDS_MeshElement* myVolume;
 194   const SMDS_PolyhedralVolumeOfNodes* myPolyedre;
 195
 196   bool                    myVolForward;
 197   int                     myNbFaces;
 198   int                     myVolumeNbNodes;
 199   const SMDS_MeshNode**   myVolumeNodes;
 200
 201   bool                    myExternalFaces;
 202
 203   int                     myCurFace;
 204   int                     myFaceNbNodes;
 205   int*                    myFaceNodeIndices;
 206   const SMDS_MeshNode**   myFaceNodes;
 207
 208 };
 209 #endif
 210
 211
 212 ///////////////////////////////////////////////////////////////////////////
 213 //
 214 //                   ORDER OF NODES OF FORWARD ELEMENT
 215 //
 216 ///////////////////////////////////////////////////////////////////////////
 217 /*
 218 //           N3
 219 //           +
 220 //          /|\
 221 //         / | \
 222 //        /  |  \
 223 //    N0 +---|---+ N1                TETRAHEDRON
 224 //       \   |   /
 225 //        \  |  /
 226 //         \ | /
 227 //          \|/
 228 //           +
 229 //           N2
 230
 231 //            + N4
 232 //           /|\
 233 //          / | \
 234 //         /  |  \
 235 //        /   |   \
 236 //    N3 +---------+ N5
 237 //       |    |    |
 238 //       |    + N1 |
 239 //       |   / \   |                PENTAHEDRON
 240 //       |  /   \  |
 241 //       | /     \ |
 242 //       |/       \|
 243 //    N0 +---------+ N2
 244
 245 //         N5+----------+N6
 246 //          /|         /|
 247 //         / |        / |
 248 //        /  |       /  |
 249 //     N4+----------+N7 |
 250 //       |   |      |   |           HEXAHEDRON
 251 //       |   |      |   |
 252 //       |   |      |   |
 253 //       | N1+------|---+N2
 254 //       |  /       |  /
 255 //       | /        | /
 256 //       |/         |/
 257 //     N0+----------+N3
 258 //
 259 */