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 #include <vtkType.h>
  42 #include <vtkCellType.h>
  43
  44 //typedef unsigned short UShortType;
  45 typedef short ShortType;
  46
  47 class SMDS_MeshNode;
  48 class SMDS_MeshEdge;
  49 class SMDS_MeshFace;
  50 class SMDS_Mesh;
  51
  52 // ============================================================
  53 /*!
  54  * \brief Base class for elements
  55  */
  56 // ============================================================
  57
  58
  59 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
  60 {
  61 public:
  62
  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;
  69
  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(); }
  74
  75   virtual int NbNodes() const;
  76   virtual int NbEdges() const;
  77   virtual int NbFaces() const;
  78   inline int GetID() const { return myID; };
  79
  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;
  87
  88   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
  89   virtual int  NbCornerNodes() const;
  90
  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;
  97
  98   // ===========================
  99   //  Access to nodes by index
 100   // ===========================
 101   /*!
 102    * \brief Return node by its index
 103     * \param ind - node index
 104     * \retval const SMDS_MeshNode* - the node
 105    */
 106   virtual const SMDS_MeshNode* GetNode(const int ind) const;
 107
 108   /*!
 109    * \brief Return node by its index
 110     * \param ind - node index
 111     * \retval const SMDS_MeshNode* - the node
 112    *
 113    * Index is wrapped if it is out of a valid range
 114    */
 115   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
 116
 117   /*!
 118    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
 119     * \param ind - node index
 120     * \retval bool - index check result
 121    */
 122   virtual bool IsValidIndex(const int ind) const;
 123
 124   /*!
 125    * \brief Return a valid node index, fixing the given one if necessary
 126     * \param ind - node index
 127     * \retval int - valid node index
 128    */
 129   int WrappedIndex(const int ind) const {
 130     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
 131     if ( ind >= NbNodes() ) return ind % NbNodes();
 132     return ind;
 133   }
 134
 135   /*!
 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
 139    */
 140   int GetNodeIndex( const SMDS_MeshNode* node ) const;
 141
 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; };
 146
 147 protected:
 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;
 156
 157   //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
 158   int myID;
 159   //! index in vtkUnstructuredGrid
 160   int myVtkID;
 161   //! SMDS_Mesh identification in SMESH
 162   ShortType myMeshId;
 163   //! SubShape and SubMesh identification in SMESHDS
 164   ShortType myShapeId;
 165   //! Element index in SMESHDS_SubMesh vector
 166   int myIdInShape;
 167 };
 168
 169
 170 // ============================================================
 171 /*!
 172  * \brief Comparator of elements by ID for usage in std containers
 173  */
 174 // ============================================================
 175
 176 struct TIDCompare {
 177   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
 178   { return e1->GetID() < e2->GetID(); }
 179 };
 180
 181 #endif