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