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.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  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 class SMDS_MeshElement;
  34 class SMDS_MeshNode;
  35 class SMDS_PolyhedralVolumeOfNodes;
  36
  37 #include <vector>
  38 #include <set>
  39
  40 //#ifdef WNT
  41 //#include <SALOME_WNT.hxx>
  42 //#else
  43 //#define SALOME_WNT_EXPORT
  44 //#endif
  45
  46 #if defined WNT && defined WIN32 && defined SMDS_EXPORTS
  47 #define SMDS_WNT_EXPORT __declspec( dllexport )
  48 #else
  49 #define SMDS_WNT_EXPORT
  50 #endif
  51
  52 // =========================================================================
  53 //
  54 // Class providing topological and other information about SMDS_MeshVolume:
  55 // allows iteration on faces or, to be precise, on nodes of volume sides;
  56 // provides info on nodes connection etc.
  57 //
  58 // =========================================================================
  59
  60 class SMDS_WNT_EXPORT SMDS_VolumeTool
  61 {
  62  public:
  63
  64   enum VolumeType { UNKNOWN = -1, TETRA = 0, PYRAM, PENTA, HEXA, QUAD_TETRA,
  65                     QUAD_PYRAM, QUAD_PENTA, QUAD_HEXA, POLYHEDA };
  66
  67   SMDS_VolumeTool ();
  68   ~SMDS_VolumeTool ();
  69   SMDS_VolumeTool (const SMDS_MeshElement* theVolume);
  70
  71   bool Set (const SMDS_MeshElement* theVolume);
  72   // Set volume.
  73   // Return false if theVolume is not of type SMDSAbs_Volume
  74
  75   // -----------------------
  76   // general info
  77   // -----------------------
  78
  79   VolumeType GetVolumeType() const;
  80
  81   bool IsForward() const { return myVolForward; }
  82   // Check volume orientation. can be changed by Inverse().
  83   // See node order of forward volumes at the file bottom
  84
  85   void Inverse();
  86   // Change nodes order as if the volume changes its orientation:
  87   // top and bottom faces are reversed.
  88   // Result of IsForward() and methods returning nodes change
  89
  90   const SMDS_MeshNode** GetNodes() { return myVolumeNodes; }
  91   // Return array of volume nodes
  92
  93   int NbNodes() { return myVolumeNbNodes; }
  94   // Return array of volume nodes
  95
  96   double GetSize() const;
  97   // Return element volume
  98
  99   bool GetBaryCenter (double & X, double & Y, double & Z) const;
 100
 101
 102   // -----------------------
 103   // info on node connection
 104   // -----------------------
 105
 106   bool IsLinked (const SMDS_MeshNode* theNode1,
 107                  const SMDS_MeshNode* theNode2) const;
 108   // Return true if theNode1 is linked with theNode2.
 109
 110   bool IsLinked (const int theNode1Index,
 111                  const int theNode2Index) const;
 112   // Return true if the node with theNode1Index is linked
 113   // with the node with theNode2Index
 114
 115   int GetNodeIndex(const SMDS_MeshNode* theNode) const;
 116   // Return an index of theNode
 117
 118   // -------------
 119   // info on faces
 120   // -------------
 121
 122   void SetExternalNormal ();
 123   // Node order in faces  will be so that faces normals are external.
 124
 125   int NbFaces() const { return myNbFaces; }
 126   // Return number of faces of the volume. In the following
 127   // methods 0 <= faceIndex < NbFaces()
 128
 129   int NbFaceNodes( int faceIndex );
 130   // Return number of nodes in the array of face nodes
 131
 132   const int* GetFaceNodesIndices( int faceIndex );
 133   // Return the array of face nodes indices
 134   // To comfort link iteration, the array
 135   // length == NbFaceNodes( faceIndex ) + 1 and
 136   // the last node index == the first one.
 137
 138   const SMDS_MeshNode** GetFaceNodes( int faceIndex );
 139   // Return the array of face nodes.
 140   // To comfort link iteration, the array
 141   // length == NbFaceNodes( faceIndex ) + 1 and
 142   // the last node == the first one.
 143   // WARNING: do not modify the array, some methods
 144   //          work basing on its contents
 145
 146   bool GetFaceNodes (int faceIndex,
 147                      std::set<const SMDS_MeshNode*>& theFaceNodes );
 148   // Return a set of face nodes.
 149
 150   bool IsFaceExternal( int faceIndex );
 151   // Check normal orientation of a face.
 152   // SetExternalNormal() is taken into account.
 153
 154   bool IsFreeFace(  int faceIndex );
 155   // Check that all volumes built on the face nodes lays on one side
 156
 157   bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z);
 158   // Return a normal to a face
 159
 160   double GetFaceArea( int faceIndex );
 161   // Return face area
 162
 163   int GetOppFaceIndex( int faceIndex ) const;
 164   // Return index of the opposite face if it exists, else -1.
 165
 166   int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes );
 167   // Return index of a face formed by theFaceNodes.
 168   // Return -1 if a face not found
 169
 170   //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
 171   // Return index of a face formed by theFaceNodesIndices
 172   // Return -1 if a face not found
 173
 174   // ------------------------
 175   // static methods for faces
 176   // ------------------------
 177
 178   static VolumeType GetType(int nbNodes);
 179   // return VolumeType by nb of nodes in a volume
 180
 181   static int NbFaces( VolumeType type );
 182   // return nb of faces by volume type
 183
 184   static const int* GetFaceNodesIndices(VolumeType type,
 185                                         int        faceIndex,
 186                                         bool       external);
 187   // Return the array of face nodes indices
 188   // To comfort link iteration, the array
 189   // length == NbFaceNodes( faceIndex ) + 1 and
 190   // the last node index == the first one.
 191
 192   static int NbFaceNodes(VolumeType type,
 193                          int        faceIndex );
 194   // Return number of nodes in the array of face nodes
 195
 196  private:
 197
 198   bool setFace( int faceIndex );
 199
 200   const SMDS_MeshElement* myVolume;
 201   const SMDS_PolyhedralVolumeOfNodes* myPolyedre;
 202
 203   bool                    myVolForward;
 204   int                     myNbFaces;
 205   int                     myVolumeNbNodes;
 206   const SMDS_MeshNode**   myVolumeNodes;
 207
 208   bool                    myExternalFaces;
 209
 210   int                     myCurFace;
 211   int                     myFaceNbNodes;
 212   int*                    myFaceNodeIndices;
 213   const SMDS_MeshNode**   myFaceNodes;
 214
 215 };
 216 #endif
 217
 218
 219 ///////////////////////////////////////////////////////////////////////////
 220 //
 221 //                   ORDER OF NODES OF FORWARD ELEMENT
 222 //
 223 ///////////////////////////////////////////////////////////////////////////
 224 /*
 225 //           N3
 226 //           +
 227 //          /|\
 228 //         / | \
 229 //        /  |  \
 230 //    N0 +---|---+ N1                TETRAHEDRON
 231 //       \   |   /
 232 //        \  |  /
 233 //         \ | /
 234 //          \|/
 235 //           +
 236 //           N2
 237
 238 //            + N4
 239 //           /|\
 240 //          / | \
 241 //         /  |  \
 242 //        /   |   \
 243 //    N3 +---------+ N5
 244 //       |    |    |
 245 //       |    + N1 |
 246 //       |   / \   |                PENTAHEDRON
 247 //       |  /   \  |
 248 //       | /     \ |
 249 //       |/       \|
 250 //    N0 +---------+ N2
 251
 252 //         N5+----------+N6
 253 //          /|         /|
 254 //         / |        / |
 255 //        /  |       /  |
 256 //     N4+----------+N7 |
 257 //       |   |      |   |           HEXAHEDRON
 258 //       |   |      |   |
 259 //       |   |      |   |
 260 //       | N1+------|---+N2
 261 //       |  /       |  /
 262 //       | /        | /
 263 //       |/         |/
 264 //     N0+----------+N3
 265 //
 266 */