]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMDS/SMDS_MeshElement.hxx
Salome HOME
4634548aa4f2fa9146bd251edbf23c7300627196
[modules/smesh.git] / src / SMDS / SMDS_MeshElement.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
23 //  SMESH SMDS : implementation of Salome mesh data structure
24 //  File   : SMDS_MeshElement.hxx
25 //  Module : SMESH
26 //
27 #ifndef _SMDS_MeshElement_HeaderFile
28 #define _SMDS_MeshElement_HeaderFile
29
30 #include "SMESH_SMDS.hxx"
31         
32 #include "SMDSAbs_ElementType.hxx"
33 #include "SMDS_MeshObject.hxx"
34 #include "SMDS_ElemIterator.hxx"
35 #include "SMDS_MeshElementIDFactory.hxx"
36 #include "SMDS_StdIterator.hxx"
37
38 #include <vector>
39 #include <iostream>
40
41 #include <vtkType.h>
42 #include <vtkCellType.h>
43
44 //typedef unsigned short UShortType;
45 typedef short ShortType;
46 typedef int   LongType;
47
48 class SMDS_MeshNode;
49 class SMDS_MeshEdge;
50 class SMDS_MeshFace;
51 class SMDS_Mesh;
52
53 // ============================================================
54 /*!
55  * \brief Base class for elements
56  */
57 // ============================================================
58
59
60 class SMDS_EXPORT SMDS_MeshElement : public SMDS_MeshObject
61 {
62 public:
63
64   SMDS_ElemIteratorPtr nodesIterator() const;
65   SMDS_ElemIteratorPtr edgesIterator() const;
66   SMDS_ElemIteratorPtr facesIterator() const;
67   virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
68   virtual SMDS_ElemIteratorPtr interlacedNodesElemIterator() const;
69
70   virtual SMDS_NodeIteratorPtr nodeIterator() const;
71   virtual SMDS_NodeIteratorPtr interlacedNodesIterator() const;
72   virtual SMDS_NodeIteratorPtr nodesIteratorToUNV() const;
73
74   // std-like iteration on nodes
75   typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
76   iterator begin_nodes() const { return iterator( nodesIterator() ); }
77   iterator end_nodes()   const { return iterator(); }
78
79   virtual int NbNodes() const;
80   virtual int NbEdges() const;
81   virtual int NbFaces() const;
82   inline int GetID() const { return myID; }
83
84   ///Return the type of the current element
85   virtual SMDSAbs_ElementType  GetType() const = 0;
86   virtual SMDSAbs_EntityType   GetEntityType() const = 0;
87   virtual SMDSAbs_GeometryType GetGeomType() const = 0;
88   virtual vtkIdType            GetVtkType() const = 0;
89
90   virtual bool IsPoly() const { return false; }
91   virtual bool IsQuadratic() const;
92   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
93   virtual int  NbCornerNodes() const;
94
95   friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
96   friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
97   friend class SMDS_Mesh;
98   friend class SMESHDS_Mesh;
99   friend class SMESHDS_SubMesh;
100   friend class SMDS_MeshElementIDFactory;
101
102   // ===========================
103   //  Access to nodes by index
104   // ===========================
105   /*!
106    * \brief Return node by its index
107     * \param ind - node index
108     * \retval const SMDS_MeshNode* - the node
109    */
110   virtual const SMDS_MeshNode* GetNode(const int ind) const;
111
112   /*!
113    * \brief Return node by its index
114     * \param ind - node index
115     * \retval const SMDS_MeshNode* - the node
116    * 
117    * Index is wrapped if it is out of a valid range
118    */
119   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
120
121   /*!
122    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
123     * \param ind - node index
124     * \retval bool - index check result
125    */
126   virtual bool IsValidIndex(const int ind) const;
127
128   /*!
129    * \brief Return a valid node index, fixing the given one if necessary
130     * \param ind - node index
131     * \retval int - valid node index
132    */
133   int WrappedIndex(const int ind) const {
134     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
135     if ( ind >= NbNodes() ) return ind % NbNodes();
136     return ind;
137   }
138
139   /*!
140    * \brief Check if a node belongs to the element
141     * \param node - the node to check
142     * \retval int - node index within the element, -1 if not found
143    */
144   virtual int GetNodeIndex( const SMDS_MeshNode* node ) const;
145
146   inline ShortType getMeshId()    const { return myMeshId; }
147   inline LongType  getshapeId()   const { return myShapeId >> BITS_SHIFT; }
148   inline int       getIdInShape() const { return myIdInShape; }
149   inline int       getVtkId()     const { return myVtkID; }
150
151   // mark this element; to be used in algos
152   inline void setIsMarked( bool is ) const;
153   inline bool isMarked() const;
154
155   /*!
156    * \brief Filters of elements, to be used with SMDS_SetIterator
157    */
158   struct Filter
159   {
160     virtual bool operator()(const SMDS_MeshElement* e) const = 0;
161     virtual ~Filter() {}
162   };
163   struct NonNullFilter: public Filter
164   {
165     bool operator()(const SMDS_MeshElement* e) const { return e; }
166   };
167   struct TypeFilter : public Filter
168   {
169     SMDSAbs_ElementType _type;
170     TypeFilter( SMDSAbs_ElementType t = SMDSAbs_NbElementTypes ):_type(t) {}
171     bool operator()(const SMDS_MeshElement* e) const { return e && e->GetType() == _type; }
172   };
173   struct EntityFilter : public Filter
174   {
175     SMDSAbs_EntityType _type;
176     EntityFilter( SMDSAbs_EntityType t = SMDSEntity_Last ):_type(t) {}
177     bool operator()(const SMDS_MeshElement* e) const { return e && e->GetEntityType() == _type; }
178   };
179   struct GeomFilter : public Filter
180   {
181     SMDSAbs_GeometryType _type;
182     GeomFilter( SMDSAbs_GeometryType t = SMDSGeom_NONE ):_type(t) {}
183     bool operator()(const SMDS_MeshElement* e) const { return e && e->GetGeomType() == _type; }
184   };
185
186 protected:
187   inline void setId(int id)                { myID = id; }
188   inline void setVtkId(int vtkId)          { myVtkID = vtkId; }
189   inline void setIdInShape(int id)         { myIdInShape = id; }
190   inline void setShapeId(LongType shapeId) { myShapeId = ( shapeId << BITS_SHIFT ) | ( myShapeId & BIT_IS_MARKED ); }
191   SMDS_MeshElement(int ID=-1);
192   SMDS_MeshElement(int id, ShortType meshId, LongType shapeId = 0);
193   virtual void init(int id = -1, ShortType meshId = -1, LongType shapeId = 0);
194   virtual void Print(std::ostream & OS) const;
195
196   //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
197   int myID;
198   //! index in vtkUnstructuredGrid
199   int myVtkID;
200   //! SMDS_Mesh identification in SMESH
201   ShortType myMeshId;
202   //! SubShape and SubMesh identification in SMESHDS; one bit is used to mark the element
203   LongType myShapeId;
204   //! Element index in SMESHDS_SubMesh vector
205   int myIdInShape;
206
207   enum Bits { // use the 1st right bit of myShapeId to set/unset a mark
208     BIT_IS_MARKED = 1,
209     BITS_SHIFT = 1
210   };
211 };
212
213 inline void SMDS_MeshElement::setIsMarked( bool is ) const
214 {
215   const_cast< SMDS_MeshElement* >( this )->myShapeId = ( myShapeId & ~BIT_IS_MARKED ) | is;
216 }
217 inline bool SMDS_MeshElement::isMarked() const
218 {
219   return myShapeId & BIT_IS_MARKED;
220 }
221
222 // ============================================================
223 /*!
224  * \brief Comparator of elements by ID for usage in std containers
225  */
226 // ============================================================
227
228 struct TIDTypeCompare {
229   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
230   { return e1->GetType() == e2->GetType() ? e1->GetID() < e2->GetID() : e1->GetType() < e2->GetType(); }
231 };
232
233 // WARNING: this comparator makes impossible to store both nodes and elements in the same set
234 // because there are nodes and elements with the same ID. Use TIDTypeCompare for such containers.
235 struct TIDCompare {
236   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
237   { return e1->GetID() < e2->GetID(); }
238 };
239
240 #endif