Salome HOME
0020511: EDF 1101 SMESH : Add CGNS to Mesh Format Supported
[modules/smesh.git] / src / SMESHUtils / SMESH_TypeDefs.hxx
1 // Copyright (C) 2007-2011  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.
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
36 #include <map>
37 #include <list>
38 #include <set>
39
40 typedef std::map<const SMDS_MeshElement*,
41                  std::list<const SMDS_MeshElement*> >        TElemOfElemListMap;
42 typedef std::map<const SMDS_MeshNode*, const SMDS_MeshNode*> TNodeNodeMap;
43
44 //!< Set of elements sorted by ID, to be used to assure predictability of edition
45 typedef std::set< const SMDS_MeshElement*, TIDCompare >      TIDSortedElemSet;
46 typedef std::set< const SMDS_MeshNode*,    TIDCompare >      TIDSortedNodeSet;
47
48 typedef pair< const SMDS_MeshNode*, const SMDS_MeshNode* >   NLink;
49
50
51 namespace SMESHUtils
52 {
53   /*!
54    * \brief Enforce freeing memory allocated by std::vector
55    */
56   template <class TVECTOR>
57   void FreeVector(TVECTOR& vec)
58   {
59     TVECTOR v2;
60     vec.swap( v2 );
61   }
62 }
63
64 //=======================================================================
65 /*!
66  * \brief A sorted pair of nodes
67  */
68 //=======================================================================
69
70 struct SMESH_TLink: public NLink
71 {
72   SMESH_TLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 ):NLink( n1, n2 )
73   { if ( n1->GetID() < n2->GetID() ) std::swap( first, second ); }
74   SMESH_TLink(const NLink& link ):NLink( link )
75   { if ( first->GetID() < second->GetID() ) std::swap( first, second ); }
76   const SMDS_MeshNode* node1() const { return first; }
77   const SMDS_MeshNode* node2() const { return second; }
78 };
79
80 //=======================================================================
81 /*!
82  * \brief SMESH_TLink knowing its orientation
83  */
84 //=======================================================================
85
86 struct SMESH_OrientedLink: public SMESH_TLink
87 {
88   bool _reversed;
89   SMESH_OrientedLink(const SMDS_MeshNode* n1, const SMDS_MeshNode* n2 )
90     : SMESH_TLink( n1, n2 ), _reversed( n1 != node1() ) {}
91 };
92
93 //------------------------------------------
94 /*!
95  * \brief SMDS_MeshNode -> gp_XYZ convertor
96  */
97 //------------------------------------------
98 struct SMESH_TNodeXYZ : public gp_XYZ
99 {
100   const SMDS_MeshNode* _node;
101   SMESH_TNodeXYZ( const SMDS_MeshElement* e):gp_XYZ(0,0,0),_node(0) {
102     if (e) {
103       assert( e->GetType() == SMDSAbs_Node );
104       _node = static_cast<const SMDS_MeshNode*>(e);
105       SetCoord( _node->X(), _node->Y(), _node->Z() );
106     }
107   }
108   double Distance(const SMDS_MeshNode* n)       const { return (SMESH_TNodeXYZ( n )-*this).Modulus(); }
109   double SquareDistance(const SMDS_MeshNode* n) const { return (SMESH_TNodeXYZ( n )-*this).SquareModulus(); }
110   bool operator==(const SMESH_TNodeXYZ& other) const { return _node == other._node; }
111 };
112
113 // --------------------------------------------------------------------------------
114 // class SMESH_SequenceOfElemPtr
115 #include <NCollection_DefineSequence.hxx>
116
117 class SMDS_MeshElement;
118
119 typedef const SMDS_MeshElement* SMDS_MeshElementPtr;
120
121 DEFINE_BASECOLLECTION (SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
122 DEFINE_SEQUENCE (SMESH_SequenceOfElemPtr, SMESH_BaseCollectionElemPtr, SMDS_MeshElementPtr)
123
124
125 // --------------------------------------------------------------------------------
126 // class SMESH_SequenceOfNode
127 typedef const SMDS_MeshNode* SMDS_MeshNodePtr;
128
129 DEFINE_BASECOLLECTION (SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
130 DEFINE_SEQUENCE(SMESH_SequenceOfNode,
131                 SMESH_BaseCollectionNodePtr, SMDS_MeshNodePtr)
132
133 // --------------------------------------------------------------------------------
134 // #include "SMESHDS_DataMapOfShape.hxx"
135
136 // #include <NCollection_DefineIndexedMap.hxx>
137
138 // #include <TopoDS_Shape.hxx>
139
140 ///  Class SMESH_IndexedMapOfShape
141
142 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionShape, TopoDS_Shape)
143 // DEFINE_INDEXEDMAP (SMESH_IndexedMapOfShape, SMESH_BaseCollectionShape, TopoDS_Shape)
144
145 ///  Class SMESH_IndexedDataMapOfShapeIndexedMapOfShape
146
147 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionIndexedMapOfShape, SMESH_IndexedMapOfShape)
148 // DEFINE_INDEXEDDATAMAP (SMESH_IndexedDataMapOfShapeIndexedMapOfShape,
149 //                        SMESH_BaseCollectionIndexedMapOfShape, TopoDS_Shape,
150 //                        SMESH_IndexedMapOfShape)
151
152 // --------------------------------------------------------------------------------
153 // class SMESH_DataMapOfElemPtrSequenceOfElemPtr
154
155 // SMESHUtils_EXPORT 
156 // inline Standard_Integer HashCode(SMDS_MeshElementPtr theElem,
157 //                                  const Standard_Integer theUpper)
158 // {
159 //   void* anElem = (void*) theElem;
160 //   return HashCode(anElem,theUpper);
161 // }
162
163 // SMESHUtils_EXPORT 
164 // inline Standard_Boolean IsEqual(SMDS_MeshElementPtr theOne,
165 //                                 SMDS_MeshElementPtr theTwo)
166 // {
167 //   return theOne == theTwo;
168 // }
169
170 // DEFINE_BASECOLLECTION (SMESH_BaseCollectionSequenceOfElemPtr, SMESH_SequenceOfElemPtr)
171 // DEFINE_DATAMAP (SMESH_DataMapOfElemPtrSequenceOfElemPtr,
172 //                 SMESH_BaseCollectionSequenceOfElemPtr,
173 //                 SMDS_MeshElementPtr, SMESH_SequenceOfElemPtr)
174
175 #endif