src/SMDS/SMDS_MeshElement.hxx

   1 //  Copyright (C) 2007-2008  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 //  SMESH SMDS : implementaion of Salome mesh data structure
  23 //  File   : SMDS_MeshElement.hxx
  24 //  Module : SMESH
  25 //
  26 #ifndef _SMDS_MeshElement_HeaderFile
  27 #define _SMDS_MeshElement_HeaderFile
  28
  29 #include "SMESH_SMDS.hxx"
  30
  31 #include "SMDSAbs_ElementType.hxx"
  32 #include "SMDS_MeshObject.hxx"
  33 #include "SMDS_ElemIterator.hxx"
  34 #include "SMDS_MeshElementIDFactory.hxx"
  35
  36 #include <vector>
  37 #include <iostream>
  38
  39 #include <vtkType.h>
  40 #include <vtkCellType.h>
  41
  42 //typedef unsigned short UShortType;
  43 typedef short ShortType;
  44
  45 class SMDS_MeshNode;
  46 class SMDS_MeshEdge;
  47 class SMDS_MeshFace;
  48 class SMDS_Mesh;
  49
  50 // ============================================================
  51 /*!
  52  * \brief Base class for elements
  53  */
  54 // ============================================================
  55
  56
  57 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
  58 {
  59 public:
  60
  61   SMDS_ElemIteratorPtr nodesIterator() const;
  62   SMDS_ElemIteratorPtr edgesIterator() const;
  63   SMDS_ElemIteratorPtr facesIterator() const;
  64   virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
  65
  66   virtual int NbNodes() const;
  67   virtual int NbEdges() const;
  68   virtual int NbFaces() const;
  69   int GetID() const;
  70
  71   ///Return the type of the current element
  72   virtual SMDSAbs_ElementType GetType() const = 0;
  73   virtual vtkIdType GetVtkType() const = 0;
  74   virtual bool IsPoly() const { return false; };
  75   virtual bool IsQuadratic() const;
  76   //! Return type of entity
  77   virtual SMDSAbs_EntityType  GetEntityType() const = 0;
  78
  79   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
  80
  81   friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
  82   friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
  83   friend class SMDS_Mesh;
  84
  85   // ===========================
  86   //  Access to nodes by index
  87   // ===========================
  88   /*!
  89    * \brief Return node by its index
  90     * \param ind - node index
  91     * \retval const SMDS_MeshNode* - the node
  92    */
  93   virtual const SMDS_MeshNode* GetNode(const int ind) const;
  94
  95   /*!
  96    * \brief Return node by its index
  97     * \param ind - node index
  98     * \retval const SMDS_MeshNode* - the node
  99    *
 100    * Index is wrapped if it is out of a valid range
 101    */
 102   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
 103
 104   /*!
 105    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
 106     * \param ind - node index
 107     * \retval bool - index check result
 108    */
 109   virtual bool IsValidIndex(const int ind) const;
 110
 111   /*!
 112    * \brief Return a valid node index, fixing the given one if necessary
 113     * \param ind - node index
 114     * \retval int - valid node index
 115    */
 116   int WrappedIndex(const int ind) const {
 117     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
 118     if ( ind >= NbNodes() ) return ind % NbNodes();
 119     return ind;
 120   }
 121
 122   /*!
 123    * \brief Check if a node belongs to the element
 124     * \param node - the node to check
 125     * \retval int - node index within the element, -1 if not found
 126    */
 127   int GetNodeIndex( const SMDS_MeshNode* node ) const;
 128
 129   inline int getId() const {return myID; };
 130   inline ShortType getMeshId() const {return myMeshId; };
 131   inline ShortType getshapeId() const {return myShapeId; };
 132   inline void setShapeId(ShortType shapeId) {myShapeId = shapeId; };
 133   inline int getIdInShape() const { return myIdInShape; };
 134   inline void setIdInShape(int id) { myIdInShape = id; };
 135
 136 protected:
 137   SMDS_MeshElement(int ID=-1);
 138   SMDS_MeshElement(int id, ShortType meshId, ShortType shapeId=-1);
 139   virtual void Print(std::ostream & OS) const;
 140
 141   //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
 142   int myID;
 143
 144   //! SMDS_Mesh identification in SMESH
 145   ShortType myMeshId;
 146
 147   //! SubShape and SubMesh identification in SMESHDS (not in use?)
 148   ShortType myShapeId;
 149
 150   //! Element index in SMESHDS_SubMesh vector
 151   int myIdInShape;
 152 };
 153
 154
 155 // ============================================================
 156 /*!
 157  * \brief Comparator of elements by ID for usage in std containers
 158  */
 159 // ============================================================
 160
 161 struct TIDCompare {
 162   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
 163   { return e1->GetID() < e2->GetID(); }
 164 };
 165
 166 #endif