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