1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // SMESH SMDS : implementaion of Salome mesh data structure
24 // File : SMDS_MeshElement.hxx
27 #ifndef _SMDS_MeshElement_HeaderFile
28 #define _SMDS_MeshElement_HeaderFile
30 #include "SMESH_SMDS.hxx"
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"
42 #include <vtkCellType.h>
44 //typedef unsigned short UShortType;
45 typedef short ShortType;
53 // ============================================================
55 * \brief Base class for elements
57 // ============================================================
60 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
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 nodesIteratorToUNV() const;
69 virtual SMDS_ElemIteratorPtr interlacedNodesElemIterator() const;
71 // std-like iteration on nodes
72 typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
73 iterator begin_nodes() const { return iterator( nodesIterator() ); }
74 iterator end_nodes() const { return iterator(); }
76 virtual int NbNodes() const;
77 virtual int NbEdges() const;
78 virtual int NbFaces() const;
79 inline int GetID() const { return myID; };
81 ///Return the type of the current element
82 virtual SMDSAbs_ElementType GetType() const = 0;
83 virtual SMDSAbs_EntityType GetEntityType() const = 0;
84 virtual SMDSAbs_GeometryType GetGeomType() const = 0;
85 virtual vtkIdType GetVtkType() const = 0;
86 virtual bool IsPoly() const { return false; }
87 virtual bool IsQuadratic() const;
89 virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
90 virtual int NbCornerNodes() const;
92 friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
93 friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
94 friend class SMDS_Mesh;
95 friend class SMESHDS_Mesh;
96 friend class SMESHDS_SubMesh;
97 friend class SMDS_MeshElementIDFactory;
99 // ===========================
100 // Access to nodes by index
101 // ===========================
103 * \brief Return node by its index
104 * \param ind - node index
105 * \retval const SMDS_MeshNode* - the node
107 virtual const SMDS_MeshNode* GetNode(const int ind) const;
110 * \brief Return node by its index
111 * \param ind - node index
112 * \retval const SMDS_MeshNode* - the node
114 * Index is wrapped if it is out of a valid range
116 const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
119 * \brief Return true if index of node is valid (0 <= ind < NbNodes())
120 * \param ind - node index
121 * \retval bool - index check result
123 virtual bool IsValidIndex(const int ind) const;
126 * \brief Return a valid node index, fixing the given one if necessary
127 * \param ind - node index
128 * \retval int - valid node index
130 int WrappedIndex(const int ind) const {
131 if ( ind < 0 ) return NbNodes() + ind % NbNodes();
132 if ( ind >= NbNodes() ) return ind % NbNodes();
137 * \brief Check if a node belongs to the element
138 * \param node - the node to check
139 * \retval int - node index within the element, -1 if not found
141 int GetNodeIndex( const SMDS_MeshNode* node ) const;
143 inline ShortType getMeshId() const { return myMeshId; }
144 inline LongType getshapeId() const { return myShapeId; }
145 inline int getIdInShape() const { return myIdInShape; }
146 inline int getVtkId() const { return myVtkID; }
149 * \brief Filters of elements, to be used with SMDS_SetIterator
153 SMDSAbs_ElementType _type;
154 TypeFilter( SMDSAbs_ElementType t = SMDSAbs_NbElementTypes ):_type(t) {}
155 bool operator()(const SMDS_MeshElement* e) const { return e && e->GetType() == _type; }
159 SMDSAbs_EntityType _type;
160 EntityFilter( SMDSAbs_EntityType t = SMDSEntity_Last ):_type(t) {}
161 bool operator()(const SMDS_MeshElement* e) const { return e && e->GetEntityType() == _type; }
165 SMDSAbs_GeometryType _type;
166 GeomFilter( SMDSAbs_GeometryType t = SMDSGeom_NONE ):_type(t) {}
167 bool operator()(const SMDS_MeshElement* e) const { return e && e->GetGeomType() == _type; }
171 inline void setId(int id) {myID = id; }
172 inline void setShapeId(LongType shapeId) {myShapeId = shapeId; }
173 inline void setIdInShape(int id) { myIdInShape = id; }
174 inline void setVtkId(int vtkId) { myVtkID = vtkId; }
175 SMDS_MeshElement(int ID=-1);
176 SMDS_MeshElement(int id, ShortType meshId, LongType shapeId = 0);
177 virtual void init(int id = -1, ShortType meshId = -1, LongType shapeId = 0);
178 virtual void Print(std::ostream & OS) const;
180 //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
182 //! index in vtkUnstructuredGrid
184 //! SMDS_Mesh identification in SMESH
186 //! SubShape and SubMesh identification in SMESHDS
188 //! Element index in SMESHDS_SubMesh vector
193 // ============================================================
195 * \brief Comparator of elements by ID for usage in std containers
197 // ============================================================
200 bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
201 { return e1->GetID() < e2->GetID(); }