src/SMDS/SMDS_MeshElement.hxx

   1 //  SMESH SMDS : implementaion of Salome mesh data structure
   2 //
   3 //  Copyright (C) 2003  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 //
  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
  37 #include <vector>
  38 #include <iostream>
  39
  40 class SMDS_MeshNode;
  41 class SMDS_MeshEdge;
  42 class SMDS_MeshFace;
  43
  44 ///////////////////////////////////////////////////////////////////////////////
  45 /// Base class for elements
  46 ///////////////////////////////////////////////////////////////////////////////
  47 class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
  48 {
  49 public:
  50
  51   SMDS_ElemIteratorPtr nodesIterator() const;
  52   SMDS_ElemIteratorPtr edgesIterator() const;
  53   SMDS_ElemIteratorPtr facesIterator() const;
  54   virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
  55
  56   virtual int NbNodes() const;
  57   virtual int NbEdges() const;
  58   virtual int NbFaces() const;
  59   int GetID() const;
  60
  61   ///Return the type of the current element
  62   virtual SMDSAbs_ElementType GetType() const = 0;
  63   virtual bool IsPoly() const { return false; };
  64   virtual bool IsQuadratic() const;
  65
  66   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
  67
  68   friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
  69   friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement*elem);
  70
  71   // ===========================
  72   //  Access to nodes by index
  73   // ===========================
  74   /*!
  75    * \brief Return node by its index
  76     * \param ind - node index
  77     * \retval const SMDS_MeshNode* - the node
  78    *
  79    * Index is wrapped if it is out of a valid range
  80    */
  81   virtual const SMDS_MeshNode* GetNode(const int ind) const;
  82
  83   /*!
  84    * \brief Return true if index of node is valid (0 <= ind < NbNodes())
  85     * \param ind - node index
  86     * \retval bool - index check result
  87    */
  88   virtual bool IsValidIndex(const int ind) const;
  89
  90   /*!
  91    * \brief Return a valid node index, fixing the given one if necessary
  92     * \param ind - node index
  93     * \retval int - valid node index
  94    */
  95   int WrappedIndex(const int ind) const {
  96     if ( ind < 0 ) return NbNodes() + ind % NbNodes();
  97     if ( ind >= NbNodes() ) return ind % NbNodes();
  98     return ind;
  99   }
 100
 101   /*!
 102    * \brief Check if a node belongs to the element
 103     * \param node - the node to check
 104     * \retval int - node index within the element, -1 if not found
 105    */
 106   int GetNodeIndex( const SMDS_MeshNode* node ) const;
 107
 108 protected:
 109   SMDS_MeshElement(int ID=-1);
 110   virtual void Print(std::ostream & OS) const;
 111
 112 private:
 113   int myID;
 114 };
 115
 116 #endif