src/SMDS/SMDS_VolumeTool.hxx

   1 // Copyright (C) 2007-2024  CEA, EDF, 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, or (at your option) any later version.
  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 : implementation 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 #include <smIdType.hxx>
  35
  36 class SMDS_MeshElement;
  37 class SMDS_MeshNode;
  38 class SMDS_MeshVolume;
  39
  40 #include <vector>
  41 #include <set>
  42 #include <map>
  43
  44 // =========================================================================
  45 //
  46 // Class providing topological and other information about SMDS_MeshVolume:
  47 // allows iteration on faces or, to be precise, on nodes of volume sides;
  48 // provides info on nodes connection etc.
  49 //
  50 // =========================================================================
  51
  52 class SMDS_EXPORT SMDS_VolumeTool
  53 {
  54  public:
  55
  56   enum VolumeType { UNKNOWN = -1, TETRA = 0, PYRAM, PENTA, HEXA,
  57                     HEX_PRISM, QUAD_TETRA, QUAD_PYRAM, QUAD_PENTA, QUAD_HEXA,
  58                     POLYHEDA, NB_VOLUME_TYPES }; // to keep synchronised with GetSize()!
  59
  60   SMDS_VolumeTool ();
  61   ~SMDS_VolumeTool ();
  62   SMDS_VolumeTool( const SMDS_MeshElement* theVolume,
  63                    const bool              ignoreCentralNodes = true);
  64
  65   bool Set( const SMDS_MeshElement*                  theVolume,
  66             const bool                               ignoreCentralNodes = true,
  67             const std::vector<const SMDS_MeshNode*>* nodes = 0);
  68   // Set volume.
  69   // Return false if theVolume is not of type SMDSAbs_Volume.
  70   // ignoreCentralNodes makes skip nodes at face centers when returning
  71   // nodes of faces of SMDSEntity_TriQuad_Hexa.
  72   // alternative nodes can be provided
  73
  74   const SMDS_MeshVolume* Element() const;
  75   // return element
  76
  77   smIdType ID() const;
  78   // return element ID
  79
  80   bool IsPoly() const { return myPolyedre; }
  81
  82   // -----------------------
  83   // general info
  84   // -----------------------
  85
  86   VolumeType GetVolumeType() const;
  87
  88   bool IsForward() const { return myVolForward; }
  89   // Check volume orientation. can be changed by Inverse().
  90   // See node order of forward volumes at the file bottom
  91
  92   void Inverse();
  93   // Change nodes order as if the volume changes its orientation:
  94   // top and bottom faces are reversed.
  95   // Result of IsForward() and methods returning nodes change
  96
  97   const SMDS_MeshNode** GetNodes() const { return (const SMDS_MeshNode**) &myVolumeNodes[0]; }
  98   // Return array of volume nodes
  99
 100   int NbNodes() const { return (int) myVolumeNodes.size(); }
 101   // Return number of volume nodes
 102
 103   double GetSize() const;
 104   // Return element volume
 105
 106   double GetScaledJacobian() const;
 107   // Return the scaled jacobian
 108
 109   bool GetBaryCenter (double & X, double & Y, double & Z) const;
 110
 111   bool IsOut(double X, double Y, double Z, double tol) const;
 112   // Classify a point
 113
 114   // -----------------------
 115   // info on node connection
 116   // -----------------------
 117
 118   bool IsLinked (const SMDS_MeshNode* theNode1,
 119                  const SMDS_MeshNode* theNode2,
 120                  const bool           theIgnoreMediumNodes=false) const;
 121   // Return true if theNode1 is linked with theNode2.
 122   // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
 123
 124   bool IsLinked (const int theNode1Index,
 125                  const int theNode2Index,
 126                  bool      theIgnoreMediumNodes=false) const;
 127   // Return true if the node with theNode1Index is linked
 128   // with the node with theNode2Index
 129   // If theIgnoreMediumNodes then corner nodes of quadratic cell are considered linked as well
 130
 131   int GetNodeIndex(const SMDS_MeshNode* theNode) const;
 132   // Return an index of theNode
 133
 134   int GetAllExistingEdges(std::vector<const SMDS_MeshElement*> & edges) const;
 135   // Fill vector with boundary edges existing in the mesh
 136
 137   double MinLinearSize2() const;
 138   // Return minimal square distance between connected corner nodes
 139
 140   double MaxLinearSize2() const;
 141   // Return maximal square distance between connected corner nodes
 142
 143   // -------------
 144   // info on faces
 145   // -------------
 146   // For all elements, 0-th face is bottom based on the first nodes.
 147   // For prismatic elements (tetra,hexa,prisms), 1-th face is a top one.
 148   // For all elements, side faces follow order of bottom nodes
 149
 150   void SetExternalNormal ();
 151   // Node order in faces  will be so that faces normals are external.
 152
 153   int NbFaces() const { return myNbFaces; }
 154   // Return number of faces of the volume. In the following
 155   // methods 0 <= faceIndex < NbFaces()
 156
 157   int NbFaceNodes( int faceIndex ) const;
 158   // Return number of nodes in the array of face nodes
 159
 160   const int* GetFaceNodesIndices( int faceIndex ) const;
 161   // Return the array of face nodes indices
 162   // To comfort link iteration, the array
 163   // length == NbFaceNodes( faceIndex ) + 1 and
 164   // the last node index == the first one, except for
 165   // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
 166   // NOTE: for the quadratic volume, node indices are in the order the nodes encounter
 167   // in face boundary and not the order they are in the mesh face
 168
 169   const SMDS_MeshNode** GetFaceNodes( int faceIndex ) const;
 170   // Return the array of face nodes.
 171   // To comfort link iteration, the array
 172   // length == NbFaceNodes( faceIndex ) + 1 and
 173   // the last node == the first one, except for
 174   // SMDSEntity_TriQuad_Hexa at ignoreCentralNodes==false.
 175   // NOTE: for the quadratic volume, nodes are in the order they encounter in face boundary
 176   // and not the order they are in the mesh face
 177   // WARNING: do not modify the array, some methods
 178   //          work basing on its contents
 179
 180   bool GetFaceNodes (int faceIndex,
 181                      std::set<const SMDS_MeshNode*>& theFaceNodes ) const;
 182   // Return a set of face nodes.
 183
 184   bool IsFaceExternal( int faceIndex ) const;
 185   // Check normal orientation of a face.
 186   // SetExternalNormal() is taken into account.
 187
 188   bool IsFreeFace(  int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
 189   // Fast check that only one volume is built on nodes of a given face
 190   // otherVol returns another volume sharing the given facet
 191
 192   bool IsFreeFaceAdv(  int faceIndex, const SMDS_MeshElement** otherVol=0 ) const;
 193   // Thorough check that all volumes built on the face nodes lays on one side
 194   // otherVol returns another volume sharing the given facet
 195
 196   bool GetFaceNormal (int faceIndex, double & X, double & Y, double & Z) const;
 197   // Return a normal to a face
 198
 199   bool GetFaceBaryCenter (int faceIndex, double & X, double & Y, double & Z) const;
 200   // Return barycenter of a face
 201
 202   bool AllFacesSameOriented() const;
 203   // Check that all the faces of a polyhedron have the same orientation
 204   // no differentiation between inward and outward orientation is made.
 205
 206   double GetFaceArea( int faceIndex ) const;
 207   // Return face area
 208
 209   int GetOppFaceIndex( int faceIndex ) const;
 210   // Return index of the opposite face if it exists, else -1.
 211
 212   int GetCenterNodeIndex( int faceIndex ) const;
 213   // Return index of the node located at face center of a quadratic element like HEX27
 214
 215   int GetFaceIndex( const std::set<const SMDS_MeshNode*>& theFaceNodes,
 216                     const int                             theFaceIndexHint=-1) const;
 217   // Return index of a face formed by theFaceNodes.
 218   // Return -1 if a face not found
 219
 220   //int GetFaceIndex( const std::set<int>& theFaceNodesIndices );
 221   // Return index of a face formed by theFaceNodesIndices
 222   // Return -1 if a face not found
 223
 224   int GetAllExistingFaces(std::vector<const SMDS_MeshElement*> & faces) const;
 225   // Fill vector with boundary faces existing in the mesh
 226
 227   // ------------------------
 228   // static methods for faces
 229   // ------------------------
 230
 231   static VolumeType GetType(int nbNodes);
 232   // return VolumeType by nb of nodes in a volume
 233
 234   static int NbFaces( VolumeType type );
 235   // return nb of faces by volume type
 236
 237   static const int* GetFaceNodesIndices(VolumeType type,
 238                                         int        faceIndex,
 239                                         bool       external);
 240   // Return the array of face nodes indices
 241   // To comfort link iteration, the array
 242   // length == NbFaceNodes( faceIndex ) + 1 and
 243   // the last node index == the first one.
 244   // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
 245
 246   static int NbFaceNodes(VolumeType type, int faceIndex );
 247   // Return number of nodes in the array of face nodes
 248   // Nodes at face centers of SMDSEntity_TriQuad_Hexa are ignored
 249
 250   static int NbCornerNodes(VolumeType type);
 251   // Useful to know nb of corner nodes of a quadratic volume
 252
 253   static int GetOppFaceIndexOfHex( int faceIndex );
 254   // Return index of the opposite face of the hexahedron
 255
 256  private:
 257
 258   bool setFace( int faceIndex ) const;
 259
 260   bool projectNodesToNormal( int     faceIndex,
 261                              double& minProj,
 262                              double& maxProj,
 263                              double* normal = 0) const;
 264
 265   const SMDS_MeshElement* myVolume;
 266   const SMDS_MeshVolume*  myPolyedre;
 267   bool                    myIgnoreCentralNodes;
 268
 269   bool                    myVolForward;
 270   int                     myNbFaces;
 271   std::vector<const SMDS_MeshNode*> myVolumeNodes;
 272   std::vector< int >      myPolyIndices; // of a myCurFace
 273   std::vector<int>        myPolyQuantities;
 274   std::vector< int >      myPolyFacetOri; // -1-in, +1-out, 0-undef
 275
 276   typedef std::pair<int,int> Link;
 277   std::map<Link, int>     myFwdLinks; // used in IsFaceExternal() to find out myPolyFacetOri
 278
 279   mutable bool            myExternalFaces;
 280
 281   mutable const int*      myAllFacesNodeIndices_F;
 282   mutable const int*      myAllFacesNodeIndices_RE;
 283   mutable const int*      myAllFacesNbNodes;
 284   mutable int             myMaxFaceNbNodes;
 285
 286   struct SaveFacet;
 287   struct Facet
 288   {
 289     int                   myIndex;
 290     int                   myNbNodes;
 291     int*                  myNodeIndices;
 292     std::vector<const SMDS_MeshNode*> myNodes;
 293   };
 294   mutable Facet           myCurFace;
 295
 296 };
 297 #endif
 298
 299
 300 ///////////////////////////////////////////////////////////////////////////
 301 //
 302 //                   ORDER OF NODES OF FORWARD ELEMENT
 303 //
 304 ///////////////////////////////////////////////////////////////////////////
 305 /*
 306 //           N3
 307 //           +
 308 //          /|\
 309 //         / | \
 310 //        /  |  \
 311 //    N0 +---|---+ N1                TETRAHEDRON
 312 //       \   |   /
 313 //        \  |  /
 314 //         \ | /
 315 //          \|/
 316 //           +
 317 //           N2
 318
 319 //            + N4
 320 //           /|\
 321 //          / | \
 322 //         /  |  \
 323 //        /   |   \
 324 //    N3 +---------+ N5
 325 //       |    |    |
 326 //       |    + N1 |
 327 //       |   / \   |                PENTAHEDRON
 328 //       |  /   \  |
 329 //       | /     \ |
 330 //       |/       \|
 331 //    N0 +---------+ N2
 332
 333 //         N5+----------+N6
 334 //          /|         /|
 335 //         / |        / |
 336 //        /  |       /  |
 337 //     N4+----------+N7 |
 338 //       |   |      |   |           HEXAHEDRON
 339 //       |   |      |   |
 340 //       |   |      |   |
 341 //       | N1+------|---+N2
 342 //       |  /       |  /
 343 //       | /        | /
 344 //       |/         |/
 345 //     N0+----------+N3
 346 //
 347 */