src/SMESHUtils/SMESH_TypeDefs.hxx

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