]> SALOME platform Git repositories - modules/smesh.git/blob - src/SMDS/SMDS_MeshElement.hxx
Salome HOME
0021196: [CEA 456] Integration and merge modification for debian packages
[modules/smesh.git] / src / SMDS / SMDS_MeshElement.hxx
1 //  Copyright (C) 2007-2010  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
23 //  SMESH SMDS : implementaion 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 class SMDS_MeshNode;
42 class SMDS_MeshEdge;
43 class SMDS_MeshFace;    
44
45 // ============================================================
46 /*!
47  * \brief Base class for elements
48  */
49 // ============================================================
50
51 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
52 {
53 public:
54
55   SMDS_ElemIteratorPtr nodesIterator() const;
56   SMDS_ElemIteratorPtr edgesIterator() const;
57   SMDS_ElemIteratorPtr facesIterator() const;
58   virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
59
60   // std-like iteration on nodes
61   typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
62   iterator begin_nodes() const { return iterator( nodesIterator() ); }
63   iterator end_nodes()   const { return iterator(); }
64
65   virtual int NbNodes() const;
66   virtual int NbEdges() const;
67   virtual int NbFaces() const;
68   int GetID() const;
69
70   ///Return the type of the current element
71   virtual SMDSAbs_ElementType GetType() const = 0;
72   virtual bool IsPoly() const { return false; }
73   virtual bool IsQuadratic() const;
74   //! Return type of entity
75   virtual SMDSAbs_EntityType  GetEntityType() const = 0;
76
77   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
78   virtual int  NbCornerNodes() const;
79
80   friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
81   friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement*elem);
82
83   // ===========================
84   //  Access to nodes by index
85   // ===========================
86   /*!
87    * \brief Return node by its index
88     * \param ind - node index
89     * \retval const SMDS_MeshNode* - the node
90    */
91   virtual const SMDS_MeshNode* GetNode(const int ind) const;
92
93   /*!
94    * \brief Return node by its index
95     * \param ind - node index
96     * \retval const SMDS_MeshNode* - the node
97    * 
98    * Index is wrapped if it is out of a valid range
99    */
100   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
101
102   /*!
103    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
104     * \param ind - node index
105     * \retval bool - index check result
106    */
107   virtual bool IsValidIndex(const int ind) const;
108
109   /*!
110    * \brief Return a valid node index, fixing the given one if necessary
111     * \param ind - node index
112     * \retval int - valid node index
113    */
114   int WrappedIndex(const int ind) const {
115     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
116     if ( ind >= NbNodes() ) return ind % NbNodes();
117     return ind;
118   }
119
120   /*!
121    * \brief Check if a node belongs to the element
122     * \param node - the node to check
123     * \retval int - node index within the element, -1 if not found
124    */
125   int GetNodeIndex( const SMDS_MeshNode* node ) const;
126
127 protected:
128   SMDS_MeshElement(int ID=-1);
129   virtual void Print(std::ostream & OS) const;
130
131 private:
132   int myID;
133 };
134
135 // ============================================================
136 /*!
137  * \brief Comparator of elements by ID for usage in std containers
138  */
139 // ============================================================
140
141 struct TIDCompare {
142   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
143   { return e1->GetID() < e2->GetID(); }
144 };
145
146 #endif