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 typedef unsigned short UShortType;
  40 typedef short ShortType;
  41
  42 class SMDS_MeshNode;
  43 class SMDS_MeshEdge;
  44 class SMDS_MeshFace;
  45
  46 // ============================================================
  47 /*!
  48  * \brief Base class for elements
  49  */
  50 // ============================================================
  51
  52 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
  53 {
  54 public:
  55
  56   SMDS_ElemIteratorPtr nodesIterator() const;
  57   SMDS_ElemIteratorPtr edgesIterator() const;
  58   SMDS_ElemIteratorPtr facesIterator() const;
  59   virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
  60
  61   virtual int NbNodes() const;
  62   virtual int NbEdges() const;
  63   virtual int NbFaces() const;
  64   int GetID() const;
  65
  66   ///Return the type of the current element
  67   virtual SMDSAbs_ElementType GetType() const = 0;
  68   virtual bool IsPoly() const { return false; };
  69   virtual bool IsQuadratic() const;
  70   //! Return type of entity
  71   virtual SMDSAbs_EntityType  GetEntityType() const = 0;
  72
  73   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
  74
  75   friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
  76   friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement*elem);
  77
  78   // ===========================
  79   //  Access to nodes by index
  80   // ===========================
  81   /*!
  82    * \brief Return node by its index
  83     * \param ind - node index
  84     * \retval const SMDS_MeshNode* - the node
  85    */
  86   virtual const SMDS_MeshNode* GetNode(const int ind) const;
  87
  88   /*!
  89    * \brief Return node by its index
  90     * \param ind - node index
  91     * \retval const SMDS_MeshNode* - the node
  92    *
  93    * Index is wrapped if it is out of a valid range
  94    */
  95   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
  96
  97   /*!
  98    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
  99     * \param ind - node index
 100     * \retval bool - index check result
 101    */
 102   virtual bool IsValidIndex(const int ind) const;
 103
 104   /*!
 105    * \brief Return a valid node index, fixing the given one if necessary
 106     * \param ind - node index
 107     * \retval int - valid node index
 108    */
 109   int WrappedIndex(const int ind) const {
 110     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
 111     if ( ind >= NbNodes() ) return ind % NbNodes();
 112     return ind;
 113   }
 114
 115   /*!
 116    * \brief Check if a node belongs to the element
 117     * \param node - the node to check
 118     * \retval int - node index within the element, -1 if not found
 119    */
 120   int GetNodeIndex( const SMDS_MeshNode* node ) const;
 121
 122   inline int getId() {return myID; };
 123   inline UShortType getMeshId() {return myMeshId; };
 124   inline ShortType getshapeId() {return myShapeId; };
 125   inline void setShapeId(UShortType shapeId) {myShapeId = shapeId; };
 126
 127 protected:
 128   SMDS_MeshElement(int ID=-1);
 129   SMDS_MeshElement(int id, UShortType meshId, ShortType shapeId=-1);
 130   virtual void Print(std::ostream & OS) const;
 131
 132   int myID;        // --- element index
 133   UShortType myMeshId;
 134   ShortType myShapeId;
 135 };
 136
 137 // ============================================================
 138 /*!
 139  * \brief Base class for all cells
 140  */
 141 // ============================================================
 142
 143 class SMDS_EXPORT SMDS_MeshCell:public SMDS_MeshElement
 144 {
 145 public:
 146     SMDS_MeshCell();
 147     inline void setVtkId(int vtkId) { myVtkID = vtkId; };
 148     inline int getVtkId() const {return myVtkID; };
 149 protected:
 150     int myVtkID;
 151 };
 152
 153
 154 // ============================================================
 155 /*!
 156  * \brief Comparator of elements by ID for usage in std containers
 157  */
 158 // ============================================================
 159
 160 struct TIDCompare {
 161   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
 162   { return e1->GetID() < e2->GetID(); }
 163 };
 164
 165 #endif