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
  68   // std-like iteration on nodes
  69   typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
  70   iterator begin_nodes() const { return iterator( nodesIterator() ); }
  71   iterator end_nodes()   const { return iterator(); }
  72
  73   virtual int NbNodes() const;
  74   virtual int NbEdges() const;
  75   virtual int NbFaces() const;
  76   int GetID() const;
  77
  78   ///Return the type of the current element
  79   virtual SMDSAbs_ElementType GetType() const = 0;
  80   virtual vtkIdType GetVtkType() const = 0;
  81   virtual bool IsPoly() const { return false; };
  82   virtual bool IsQuadratic() const;
  83   //! Return type of entity
  84   virtual SMDSAbs_EntityType  GetEntityType() const = 0;
  85
  86   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
  87   virtual int  NbCornerNodes() const;
  88
  89   friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
  90   friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
  91   friend class SMDS_Mesh;
  92   friend class SMESHDS_Mesh;
  93
  94   // ===========================
  95   //  Access to nodes by index
  96   // ===========================
  97   /*!
  98    * \brief Return node by its index
  99     * \param ind - node index
 100     * \retval const SMDS_MeshNode* - the node
 101    */
 102   virtual const SMDS_MeshNode* GetNode(const int ind) const;
 103
 104   /*!
 105    * \brief Return node by its index
 106     * \param ind - node index
 107     * \retval const SMDS_MeshNode* - the node
 108    *
 109    * Index is wrapped if it is out of a valid range
 110    */
 111   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
 112
 113   /*!
 114    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
 115     * \param ind - node index
 116     * \retval bool - index check result
 117    */
 118   virtual bool IsValidIndex(const int ind) const;
 119
 120   /*!
 121    * \brief Return a valid node index, fixing the given one if necessary
 122     * \param ind - node index
 123     * \retval int - valid node index
 124    */
 125   int WrappedIndex(const int ind) const {
 126     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
 127     if ( ind >= NbNodes() ) return ind % NbNodes();
 128     return ind;
 129   }
 130
 131   /*!
 132    * \brief Check if a node belongs to the element
 133     * \param node - the node to check
 134     * \retval int - node index within the element, -1 if not found
 135    */
 136   int GetNodeIndex( const SMDS_MeshNode* node ) const;
 137
 138   inline int getId() const {return myID; };
 139   inline ShortType getMeshId() const {return myMeshId; };
 140   inline ShortType getshapeId() const {return myShapeId; };
 141   inline void setShapeId(ShortType shapeId) {myShapeId = shapeId; };
 142   inline int getIdInShape() const { return myIdInShape; };
 143   inline void setIdInShape(int id) { myIdInShape = id; };
 144
 145 protected:
 146   inline void setId(int id) {myID = id; };
 147   SMDS_MeshElement(int ID=-1);
 148   SMDS_MeshElement(int id, ShortType meshId, ShortType shapeId=-1);
 149   virtual void Print(std::ostream & OS) const;
 150
 151   //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
 152   int myID;
 153
 154   //! SMDS_Mesh identification in SMESH
 155   ShortType myMeshId;
 156
 157   //! SubShape and SubMesh identification in SMESHDS (not in use?)
 158   ShortType myShapeId;
 159
 160   //! Element index in SMESHDS_SubMesh vector
 161   int myIdInShape;
 162 };
 163
 164
 165 // ============================================================
 166 /*!
 167  * \brief Comparator of elements by ID for usage in std containers
 168  */
 169 // ============================================================
 170
 171 struct TIDCompare {
 172   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
 173   { return e1->GetID() < e2->GetID(); }
 174 };
 175
 176 #endif