Salome HOME
9fec2e5bd7079b6199259052ce53b59584b4215c
[modules/smesh.git] / src / SMESHUtils / SMESH_TypeDefs.hxx
1 // Copyright (C) 2007-2014  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*, const SMDS_MeshNode*>      TNodeNodeMap;
47
48 //!< Set of elements sorted by ID, to be used to assure predictability of edition
49 typedef std::set< const SMDS_MeshElement*, TIDCompare >      TIDSortedElemSet;
50 typedef std::set< const SMDS_MeshNode*,    TIDCompare >      TIDSortedNodeSet;
51
52 typedef std::pair< const SMDS_MeshNode*, const SMDS_MeshNode* >   NLink;
53
54 struct FaceQuadStruct; // defined in StdMeshers_Quadrangle_2D.hxx
55 typedef boost::shared_ptr<FaceQuadStruct> TFaceQuadStructPtr;
56
57
58 namespace SMESHUtils
59 {
60   /*!
61    * \brief Enforce freeing memory allocated by std::vector
62    */
63   template <class TVECTOR>
64   void FreeVector(TVECTOR& vec)
65   {
66     TVECTOR v2;
67     vec.swap( v2 );
68   }
69   template <class TVECTOR>
70   void CompactVector(TVECTOR& vec)
71   {
72     TVECTOR v2( vec );
73     vec.swap( v2 );
74   }
75   /*!
76    * \brief Auto pointer
77    */
78   template <typename TOBJ>
79   struct Deleter
80   {
81     TOBJ* _obj;
82     Deleter( TOBJ* obj ): _obj( obj ) {}
83     ~Deleter() { delete _obj; _obj = 0; }
84   private:
85     Deleter( const Deleter& );
86   };
87   /*!
88    * \brief Auto pointer to array
89    */
90   template <typename TOBJ>
91   struct ArrayDeleter
92   {
93     TOBJ* _obj;
94     ArrayDeleter( TOBJ* obj ): _obj( obj ) {}
95     ~ArrayDeleter() { delete [] _obj; _obj = 0; }
96   private:
97     ArrayDeleter( const ArrayDeleter& );
98   };
99 }
100
101 //=======================================================================
102 /*!
103  * \brief A sorted pair of nodes
104  */
105 //=======================================================================
106
107 struct SMESH_TLink: public NLink
108 {
109   SMESH_TLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 ):NLink( n1, n2 )
110   { if ( n1->GetID() < n2->GetID() ) std::swap( first, second ); }
111   SMESH_TLink(const NLink& link ):NLink( link )
112   { if ( first->GetID() < second->GetID() ) std::swap( first, second ); }
113   const SMDS_MeshNode* node1() const { return first; }
114   const SMDS_MeshNode* node2() const { return second; }
115 };
116
117 //=======================================================================
118 /*!
119  * \brief SMESH_TLink knowing its orientation
120  */
121 //=======================================================================
122
123 struct SMESH_OrientedLink: public SMESH_TLink
124 {
125   bool _reversed;
126   SMESH_OrientedLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 )
127     : SMESH_TLink( n1, n2 ), _reversed( n1 != node1() ) {}
128 };
129
130 //------------------------------------------
131 /*!
132  * \brief SMDS_MeshNode -> gp_XYZ convertor
133  */
134 //------------------------------------------
135 struct SMESH_TNodeXYZ : public gp_XYZ
136 {
137   const SMDS_MeshNode* _node;
138   double               _xyz[3];
139   SMESH_TNodeXYZ( const SMDS_MeshElement* e=0):gp_XYZ(0,0,0),_node(0) {
140     if (e) {
141       assert( e->GetType() == SMDSAbs_Node );
142       _node = static_cast<const SMDS_MeshNode*>(e);
143       _node->GetXYZ(_xyz); // - thread safe getting coords
144       SetCoord( _xyz[0], _xyz[1], _xyz[2] );
145     }
146   }
147   double Distance(const SMDS_MeshNode* n)       const { return (SMESH_TNodeXYZ( n )-*this).Modulus(); }
148   double SquareDistance(const SMDS_MeshNode* n) const { return (SMESH_TNodeXYZ( n )-*this).SquareModulus(); }
149   bool operator==(const SMESH_TNodeXYZ& other) const { return _node == other._node; }
150 };
151
152 //--------------------------------------------------
153 /*!
154  * \brief Data of a node generated on FACE boundary
155  */
156 //--------------------------------------------------
157 typedef struct uvPtStruct
158 {
159   double param;
160   double normParam;
161   double u, v; // original 2d parameter
162   double x, y; // 2d parameter, normalized [0,1]
163   const SMDS_MeshNode * node;
164
165   uvPtStruct(): node(NULL) {}
166
167   inline gp_XY UV() const { return gp_XY( u, v ); }
168
169   struct NodeAccessor // accessor to iterate on nodes in UVPtStructVec
170   {
171     static const SMDS_MeshNode* value(std::vector< uvPtStruct >::const_iterator it)
172     { return it->node; }
173   };
174 } UVPtStruct;
175
176 typedef std::vector< UVPtStruct > UVPtStructVec;
177
178 // --------------------------------------------------------------------------------
179 // class SMESH_SequenceOfElemPtr
180 #include <NCollection_DefineSequence.hxx>
181
182 class SMDS_MeshElement;
183
184 typedef const SMDS_MeshElement* SMDS_MeshElementPtr;
185
186 DEFINE_SEQUENCE (SMESH_SequenceOfElemPtr, SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
187
188
189 // --------------------------------------------------------------------------------
190 // class SMESH_SequenceOfNode
191 typedef const SMDS_MeshNode* SMDS_MeshNodePtr;
192
193 DEFINE_SEQUENCE(SMESH_SequenceOfNode,
194                 SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
195
196 #endif