src/SMESHUtils/SMESH_TypeDefs.hxx

   1 // Copyright (C) 2007-2021  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, 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 // File      : SMESH_TypeDefs.hxx
  23 // Created   : Thu Jan 27 18:38:33 2011
  24 // Author    : Edward AGAPOV (eap)
  25
  26
  27 #ifndef __SMESH_TypeDefs_HXX__
  28 #define __SMESH_TypeDefs_HXX__
  29
  30 #include "SMESH_Utils.hxx"
  31
  32 #include "SMDS_SetIterator.hxx"
  33 #include "SMDS_MeshNode.hxx"
  34
  35 #include <smIdType.hxx>
  36
  37 #include <gp_XYZ.hxx>
  38 #include <gp_XY.hxx>
  39
  40 #include <map>
  41 #include <list>
  42 #include <set>
  43 #include <cassert>
  44
  45 #include <boost/make_shared.hpp>
  46
  47 typedef std::map<const SMDS_MeshElement*,
  48                  std::list<const SMDS_MeshElement*>, TIDCompare > TElemOfElemListMap;
  49 typedef std::map<const SMDS_MeshElement*,
  50                  std::list<const SMDS_MeshNode*>,    TIDCompare > TElemOfNodeListMap;
  51 typedef std::map<const SMDS_MeshNode*,
  52                  const SMDS_MeshNode*,               TIDCompare>  TNodeNodeMap;
  53
  54 //!< Set of elements sorted by ID, to be used to assure predictability of edition
  55 typedef std::set< const SMDS_MeshElement*, TIDCompare >      TIDSortedElemSet;
  56 typedef std::set< const SMDS_MeshNode*,    TIDCompare >      TIDSortedNodeSet;
  57
  58 typedef std::pair< const SMDS_MeshNode*, const SMDS_MeshNode* >   NLink;
  59
  60 struct FaceQuadStruct; // defined in StdMeshers_Quadrangle_2D.hxx
  61 typedef boost::shared_ptr<FaceQuadStruct> TFaceQuadStructPtr;
  62
  63
  64 namespace SMESHUtils
  65 {
  66   /*!
  67    * \brief Enforce freeing memory allocated by std::vector
  68    */
  69   template <class TVECTOR>
  70   void FreeVector(TVECTOR& vec)
  71   {
  72     TVECTOR v2;
  73     vec.swap( v2 );
  74   }
  75   template <class TVECTOR>
  76   void CompactVector(TVECTOR& vec)
  77   {
  78     TVECTOR v2( vec );
  79     vec.swap( v2 );
  80   }
  81
  82   /*!
  83    * \brief Auto pointer
  84    */
  85   template <typename TOBJ>
  86   struct Deleter
  87   {
  88     TOBJ* _obj;
  89     explicit Deleter( TOBJ* obj = (TOBJ*)NULL ): _obj( obj ) {}
  90     ~Deleter() { delete _obj; _obj = 0; }
  91     TOBJ& operator*()  const { return *_obj; }
  92     TOBJ* operator->() const { return _obj; }
  93     operator bool()    const { return _obj; }
  94   private:
  95     Deleter( const Deleter& );
  96   };
  97
  98   /*!
  99    * \brief Auto pointer to array
 100    */
 101   template <typename TOBJ>
 102   struct ArrayDeleter
 103   {
 104     TOBJ* _obj;
 105     ArrayDeleter( TOBJ* obj ): _obj( obj ) {}
 106     ~ArrayDeleter() { delete [] _obj; _obj = 0; }
 107   private:
 108     ArrayDeleter( const ArrayDeleter& );
 109   };
 110
 111   /*!
 112    * \return SMDS_ElemIteratorPtr on an std container of SMDS_MeshElement's
 113    */
 114   template < class ELEM_SET >
 115   SMDS_ElemIteratorPtr elemSetIterator( const ELEM_SET& elements )
 116   {
 117     typedef SMDS_SetIterator
 118       < SMDS_pElement, typename ELEM_SET::const_iterator> TSetIterator;
 119     return boost::make_shared< TSetIterator >( elements.begin(), elements.end() );
 120   }
 121
 122   /*!
 123    * \brief Increment enum value
 124    */
 125   template < typename ENUM >
 126   void Increment( ENUM& v, int delta=1 )
 127   {
 128     v = ENUM( int(v)+delta );
 129   }
 130
 131   /*!
 132    * \brief Return incremented enum value
 133    */
 134   template < typename ENUM >
 135   ENUM Add( ENUM v, int delta )
 136   {
 137     return ENUM( int(v)+delta );
 138   }
 139 }
 140
 141 //=======================================================================
 142 /*!
 143  * \brief A sorted pair of nodes
 144  */
 145 //=======================================================================
 146
 147 struct SMESH_TLink: public NLink
 148 {
 149   SMESH_TLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 ):NLink( n1, n2 )
 150   { if ( n1->GetID() < n2->GetID() ) std::swap( first, second ); }
 151   SMESH_TLink(const NLink& link ):NLink( link )
 152   { if ( first->GetID() < second->GetID() ) std::swap( first, second ); }
 153   const SMDS_MeshNode* node1() const { return first; }
 154   const SMDS_MeshNode* node2() const { return second; }
 155
 156   // methods for usage of SMESH_TLink as a hasher in NCollection maps
 157   static int HashCode(const SMESH_TLink& link, int aLimit)
 158   {
 159     return smIdHasher::HashCode( link.node1()->GetID() + link.node2()->GetID(), aLimit );
 160   }
 161   static Standard_Boolean IsEqual(const SMESH_TLink& l1, const SMESH_TLink& l2)
 162   {
 163     return ( l1.node1() == l2.node1() && l1.node2() == l2.node2() );
 164   }
 165 };
 166 typedef SMESH_TLink SMESH_Link;
 167
 168 //=======================================================================
 169 /*!
 170  * \brief SMESH_TLink knowing its orientation
 171  */
 172 //=======================================================================
 173
 174 struct SMESH_OrientedLink: public SMESH_TLink
 175 {
 176   bool _reversed;
 177   SMESH_OrientedLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 )
 178     : SMESH_TLink( n1, n2 ), _reversed( n1 != node1() ) {}
 179 };
 180
 181 //------------------------------------------
 182 /*!
 183  * \brief SMDS_MeshNode -> gp_XYZ converter
 184  */
 185 //------------------------------------------
 186 struct SMESH_TNodeXYZ : public gp_XYZ
 187 {
 188   const SMDS_MeshNode* _node;
 189   SMESH_TNodeXYZ( const SMDS_MeshElement* e=0):gp_XYZ(0,0,0),_node(0)
 190   {
 191     Set(e);
 192   }
 193   bool Set( const SMDS_MeshElement* e=0 )
 194   {
 195     if (e) {
 196       assert( e->GetType() == SMDSAbs_Node );
 197       _node = static_cast<const SMDS_MeshNode*>(e);
 198       _node->GetXYZ( ChangeData() ); // - thread safe getting coords
 199       return true;
 200     }
 201     return false;
 202   }
 203   const SMDS_MeshNode* Node() const { return _node; }
 204   double Distance(const SMDS_MeshNode* n)       const { return (SMESH_TNodeXYZ( n )-*this).Modulus(); }
 205   double SquareDistance(const SMDS_MeshNode* n) const { return (SMESH_TNodeXYZ( n )-*this).SquareModulus(); }
 206   bool operator==(const SMESH_TNodeXYZ& other)  const { return _node == other._node; }
 207   bool operator!=(const SMESH_TNodeXYZ& other)  const { return _node != other._node; }
 208   bool operator!() const { return !_node; }
 209   const SMDS_MeshNode* operator->() const { return _node; }
 210 };
 211 typedef SMESH_TNodeXYZ SMESH_NodeXYZ;
 212
 213 // --------------------------------------------------------------------------------
 214 // SMESH_Hasher provide methods needed to put mesh data to NCollection maps
 215
 216 struct SMESH_Hasher
 217 {
 218   static Standard_Integer HashCode(const SMDS_MeshElement* e, const Standard_Integer upper)
 219   {
 220     return smIdHasher::HashCode( e->GetID(), upper );
 221   }
 222   static Standard_Boolean IsEqual( const SMDS_MeshElement* e1, const SMDS_MeshElement* e2 )
 223   {
 224     return ( e1 == e2 );
 225   }
 226 };
 227
 228 //--------------------------------------------------
 229 /*!
 230  * \brief Data of a node generated on FACE boundary
 231  */
 232 //--------------------------------------------------
 233 typedef struct uvPtStruct
 234 {
 235   double param;
 236   double normParam;
 237   double u, v; // original 2d parameter
 238   double x, y; // 2d parameter, normalized [0,1]
 239   const SMDS_MeshNode * node;
 240
 241   uvPtStruct(const SMDS_MeshNode* n = 0): node(n) {}
 242
 243   inline gp_XY UV() const { return gp_XY( u, v ); }
 244   inline void  SetUV( const gp_XY& uv ) { u = uv.X(); v = uv.Y(); }
 245
 246   struct NodeAccessor // accessor to iterate on nodes in UVPtStructVec
 247   {
 248     static const SMDS_MeshNode* value(std::vector< uvPtStruct >::const_iterator it)
 249     { return it->node; }
 250   };
 251 } UVPtStruct;
 252
 253 typedef std::vector< UVPtStruct > UVPtStructVec;
 254
 255 // --------------------------------------------------------------------------------
 256 // class SMESH_SequenceOfElemPtr
 257
 258 typedef std::vector< const SMDS_MeshElement* > SMESH_SequenceOfElemPtr;
 259
 260 // --------------------------------------------------------------------------------
 261 // class SMESH_SequenceOfNode
 262 #include <NCollection_DefineSequence.hxx>
 263 typedef const SMDS_MeshNode* SMDS_MeshNodePtr;
 264
 265 DEFINE_SEQUENCE(SMESH_SequenceOfNode,
 266                 SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
 267
 268 #endif