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