1 // Copyright (C) 2007-2010 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;
52 // ============================================================
54 * \brief Base class for elements
56 // ============================================================
59 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
63 SMDS_ElemIteratorPtr nodesIterator() const;
64 SMDS_ElemIteratorPtr edgesIterator() const;
65 SMDS_ElemIteratorPtr facesIterator() const;
66 virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
67 virtual SMDS_ElemIteratorPtr nodesIteratorToUNV() const;
68 virtual SMDS_ElemIteratorPtr interlacedNodesElemIterator() const;
70 // std-like iteration on nodes
71 typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
72 iterator begin_nodes() const { return iterator( nodesIterator() ); }
73 iterator end_nodes() const { return iterator(); }
75 virtual int NbNodes() const;
76 virtual int NbEdges() const;
77 virtual int NbFaces() const;
78 inline int GetID() const { return myID; };
80 ///Return the type of the current element
81 virtual SMDSAbs_ElementType GetType() const = 0;
82 virtual vtkIdType GetVtkType() const = 0;
83 virtual bool IsPoly() const { return false; };
84 virtual bool IsQuadratic() const;
85 //! Return type of entity
86 virtual SMDSAbs_EntityType GetEntityType() const = 0;
88 virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
89 virtual int NbCornerNodes() const;
91 friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
92 friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
93 friend class SMDS_Mesh;
94 friend class SMESHDS_Mesh;
95 friend class SMESHDS_SubMesh;
96 friend class SMDS_MeshElementIDFactory;
98 // ===========================
99 // Access to nodes by index
100 // ===========================
102 * \brief Return node by its index
103 * \param ind - node index
104 * \retval const SMDS_MeshNode* - the node
106 virtual const SMDS_MeshNode* GetNode(const int ind) const;
109 * \brief Return node by its index
110 * \param ind - node index
111 * \retval const SMDS_MeshNode* - the node
113 * Index is wrapped if it is out of a valid range
115 const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
118 * \brief Return true if index of node is valid (0 <= ind < NbNodes())
119 * \param ind - node index
120 * \retval bool - index check result
122 virtual bool IsValidIndex(const int ind) const;
125 * \brief Return a valid node index, fixing the given one if necessary
126 * \param ind - node index
127 * \retval int - valid node index
129 int WrappedIndex(const int ind) const {
130 if ( ind < 0 ) return NbNodes() + ind % NbNodes();
131 if ( ind >= NbNodes() ) return ind % NbNodes();
136 * \brief Check if a node belongs to the element
137 * \param node - the node to check
138 * \retval int - node index within the element, -1 if not found
140 int GetNodeIndex( const SMDS_MeshNode* node ) const;
142 inline ShortType getMeshId() const {return myMeshId; }
143 inline ShortType getshapeId() const {return myShapeId; }
144 inline int getIdInShape() const { return myIdInShape; }
145 inline int getVtkId() const { return myVtkID; }
148 inline void setId(int id) {myID = id; }
149 inline void setShapeId(ShortType shapeId) {myShapeId = shapeId; }
150 inline void setIdInShape(int id) { myIdInShape = id; }
151 inline void setVtkId(int vtkId) { myVtkID = vtkId; }
152 SMDS_MeshElement(int ID=-1);
153 SMDS_MeshElement(int id, ShortType meshId, ShortType shapeId = 0);
154 virtual void init(int id = -1, ShortType meshId = -1, ShortType shapeId = 0);
155 virtual void Print(std::ostream & OS) const;
157 //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
159 //! index in vtkUnstructuredGrid
161 //! SMDS_Mesh identification in SMESH
163 //! SubShape and SubMesh identification in SMESHDS
165 //! Element index in SMESHDS_SubMesh vector
170 // ============================================================
172 * \brief Comparator of elements by ID for usage in std containers
174 // ============================================================
177 bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
178 { return e1->GetID() < e2->GetID(); }