1 // Copyright (C) 2007-2008 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
22 // SMESH SMDS : implementaion of Salome mesh data structure
23 // File : SMDS_MeshElement.hxx
26 #ifndef _SMDS_MeshElement_HeaderFile
27 #define _SMDS_MeshElement_HeaderFile
29 #include "SMESH_SMDS.hxx"
31 #include "SMDSAbs_ElementType.hxx"
32 #include "SMDS_MeshObject.hxx"
33 #include "SMDS_ElemIterator.hxx"
34 #include "SMDS_MeshElementIDFactory.hxx"
39 //typedef unsigned short UShortType;
40 typedef short ShortType;
47 // ============================================================
49 * \brief Base class for elements
51 // ============================================================
53 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
57 SMDS_ElemIteratorPtr nodesIterator() const;
58 SMDS_ElemIteratorPtr edgesIterator() const;
59 SMDS_ElemIteratorPtr facesIterator() const;
60 virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
62 virtual int NbNodes() const;
63 virtual int NbEdges() const;
64 virtual int NbFaces() const;
67 ///Return the type of the current element
68 virtual SMDSAbs_ElementType GetType() const = 0;
69 virtual bool IsPoly() const { return false; };
70 virtual bool IsQuadratic() const;
71 //! Return type of entity
72 virtual SMDSAbs_EntityType GetEntityType() const = 0;
74 virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
76 friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
77 friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
78 friend class SMDS_Mesh;
80 // ===========================
81 // Access to nodes by index
82 // ===========================
84 * \brief Return node by its index
85 * \param ind - node index
86 * \retval const SMDS_MeshNode* - the node
88 virtual const SMDS_MeshNode* GetNode(const int ind) const;
91 * \brief Return node by its index
92 * \param ind - node index
93 * \retval const SMDS_MeshNode* - the node
95 * Index is wrapped if it is out of a valid range
97 const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
100 * \brief Return true if index of node is valid (0 <= ind < NbNodes())
101 * \param ind - node index
102 * \retval bool - index check result
104 virtual bool IsValidIndex(const int ind) const;
107 * \brief Return a valid node index, fixing the given one if necessary
108 * \param ind - node index
109 * \retval int - valid node index
111 int WrappedIndex(const int ind) const {
112 if ( ind < 0 ) return NbNodes() + ind % NbNodes();
113 if ( ind >= NbNodes() ) return ind % NbNodes();
118 * \brief Check if a node belongs to the element
119 * \param node - the node to check
120 * \retval int - node index within the element, -1 if not found
122 int GetNodeIndex( const SMDS_MeshNode* node ) const;
124 inline int getId() const {return myID; };
125 inline ShortType getMeshId() const {return myMeshId; };
126 inline ShortType getshapeId() const {return myShapeId; };
127 inline void setShapeId(ShortType shapeId) {myShapeId = shapeId; };
128 inline int getIdInShape() const { return myIdInShape; };
129 inline void setIdInShape(int id) { myIdInShape = id; };
132 SMDS_MeshElement(int ID=-1);
133 SMDS_MeshElement(int id, ShortType meshId, ShortType shapeId=-1);
134 virtual void Print(std::ostream & OS) const;
136 //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
139 //! SMDS_Mesh identification in SMESH
142 //! SubShape and SubMesh identification in SMESHDS (not in use?)
145 //! Element index in SMESHDS_SubMesh vector
150 // ============================================================
152 * \brief Comparator of elements by ID for usage in std containers
154 // ============================================================
157 bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
158 { return e1->GetID() < e2->GetID(); }