Salome HOME
Merge branch 'V9_9_BR'
[modules/smesh.git] / src / SMDS / SMDS_MeshElement.hxx
index 0451789422b714e3891194c5122790a824fd68d1..cc39f2b243d2d2f4468e80253d1e7fe6a348de39 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2022  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -6,7 +6,7 @@
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -20,7 +20,7 @@
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
-//  SMESH SMDS : implementaion of Salome mesh data structure
+//  SMESH SMDS : implementation of Salome mesh data structure
 //  File   : SMDS_MeshElement.hxx
 //  Module : SMESH
 //
 #include "SMDSAbs_ElementType.hxx"
 #include "SMDS_MeshObject.hxx"
 #include "SMDS_ElemIterator.hxx"
-#include "SMDS_MeshElementIDFactory.hxx"
 #include "SMDS_StdIterator.hxx"
 
-#include <vector>
 #include <iostream>
 
 #include <vtkType.h>
 #include <vtkCellType.h>
+#include <smIdType.hxx>
 
-//typedef unsigned short UShortType;
-typedef short ShortType;
-typedef int   LongType;
-
-class SMDS_MeshNode;
-class SMDS_MeshEdge;
-class SMDS_MeshFace;
+class SMDS_ElementChunk;
 class SMDS_Mesh;
+class SMDS_MeshNode;
+class SMDS_UnstructuredGrid;
 
 // ============================================================
 /*!
@@ -57,47 +52,40 @@ class SMDS_Mesh;
 // ============================================================
 
 
-class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
+class SMDS_EXPORT SMDS_MeshElement : public SMDS_MeshObject
 {
 public:
 
-  SMDS_ElemIteratorPtr nodesIterator() const;
-  SMDS_ElemIteratorPtr edgesIterator() const;
-  SMDS_ElemIteratorPtr facesIterator() const;
-  virtual SMDS_ElemIteratorPtr elementsIterator(SMDSAbs_ElementType type) const;
-  virtual SMDS_ElemIteratorPtr interlacedNodesElemIterator() const;
+  // ===========================
+  // Access to nodes
+  // ===========================
+  virtual SMDS_ElemIteratorPtr nodesIterator() const = 0;
 
-  virtual SMDS_NodeIteratorPtr nodeIterator() const;
-  virtual SMDS_NodeIteratorPtr interlacedNodesIterator() const;
-  virtual SMDS_NodeIteratorPtr nodesIteratorToUNV() const;
+  virtual SMDS_NodeIteratorPtr nodeIterator() const = 0;
+  virtual SMDS_NodeIteratorPtr interlacedNodesIterator() const { return nodeIterator(); }
+  virtual SMDS_NodeIteratorPtr nodesIteratorToUNV() const  { return nodeIterator(); }
 
   // std-like iteration on nodes
-  typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
-  iterator begin_nodes() const { return iterator( nodesIterator() ); }
+  typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_NodeIteratorPtr > iterator;
+  iterator begin_nodes() const { return iterator( nodeIterator() ); }
   iterator end_nodes()   const { return iterator(); }
 
-  virtual int NbNodes() const;
-  virtual int NbEdges() const;
-  virtual int NbFaces() const;
-  inline int GetID() const { return myID; };
+  // ===========================
+  // Type of element
+  // ===========================
+  virtual int NbNodes() const = 0;
+  virtual int NbEdges() const = 0;
+  virtual int NbFaces() const = 0;
 
-  ///Return the type of the current element
-  virtual SMDSAbs_ElementType GetType() const = 0;
-  virtual SMDSAbs_EntityType GetEntityType() const = 0;
+  virtual SMDSAbs_ElementType  GetType() const = 0;
+  virtual SMDSAbs_EntityType   GetEntityType() const = 0;
   virtual SMDSAbs_GeometryType GetGeomType() const = 0;
-  virtual vtkIdType GetVtkType() const = 0;
-  virtual bool IsPoly() const { return false; }
-  virtual bool IsQuadratic() const;
+  virtual VTKCellType          GetVtkType() const = 0;
 
+  virtual bool IsPoly() const = 0;
+  virtual bool IsQuadratic() const = 0;
   virtual bool IsMediumNode(const SMDS_MeshNode* node) const;
-  virtual int  NbCornerNodes() const;
-
-  friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
-  friend SMDS_EXPORT bool SMDS_MeshElementIDFactory::BindID(int ID,SMDS_MeshElement* elem);
-  friend class SMDS_Mesh;
-  friend class SMESHDS_Mesh;
-  friend class SMESHDS_SubMesh;
-  friend class SMDS_MeshElementIDFactory;
+  virtual int  NbCornerNodes() const = 0;
 
   // ===========================
   //  Access to nodes by index
@@ -107,14 +95,14 @@ public:
     * \param ind - node index
     * \retval const SMDS_MeshNode* - the node
    */
-  virtual const SMDS_MeshNode* GetNode(const int ind) const;
+  virtual const SMDS_MeshNode* GetNode(const int ind) const = 0;
 
   /*!
    * \brief Return node by its index
     * \param ind - node index
     * \retval const SMDS_MeshNode* - the node
    * 
-   * Index is wrapped if it is out of a valid range
+   * Index is wrapped if it is out of a valid range of corner nodes
    */
   const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
 
@@ -126,15 +114,11 @@ public:
   virtual bool IsValidIndex(const int ind) const;
 
   /*!
-   * \brief Return a valid node index, fixing the given one if necessary
+   * \brief Return a valid corner node index, fixing the given one if necessary
     * \param ind - node index
     * \retval int - valid node index
    */
-  int WrappedIndex(const int ind) const {
-    if ( ind < 0 ) return NbNodes() + ind % NbNodes();
-    if ( ind >= NbNodes() ) return ind % NbNodes();
-    return ind;
-  }
+  int WrappedIndex(const int ind) const;
 
   /*!
    * \brief Check if a node belongs to the element
@@ -143,10 +127,26 @@ public:
    */
   virtual int GetNodeIndex( const SMDS_MeshNode* node ) const;
 
-  inline ShortType getMeshId()  const { return myMeshId; }
-  inline LongType  getshapeId() const { return myShapeId; }
-  inline int getIdInShape()     const { return myIdInShape; }
-  inline int getVtkId()         const { return myVtkID; }
+
+  virtual smIdType  GetID() const;
+  virtual vtkIdType GetVtkID()   const;
+  virtual int  getshapeId() const { return GetShapeID(); }
+  virtual int  GetShapeID() const;
+
+  // mark this element; to be used in algos
+  virtual void setIsMarked( bool is ) const;
+  virtual bool isMarked() const;
+
+  // element can be allocated but "not used"
+  bool IsNull() const { return myHolder == 0; }
+
+  SMDS_Mesh* GetMesh() const;
+
+  void Print(std::ostream & OS) const;
+
+  friend SMDS_EXPORT std::ostream & operator <<(std::ostream & OS, const SMDS_MeshElement *);
+  friend class SMDS_ElementFactory;
+  friend class SMESHDS_SubMesh;
 
   /*!
    * \brief Filters of elements, to be used with SMDS_SetIterator
@@ -154,7 +154,7 @@ public:
   struct Filter
   {
     virtual bool operator()(const SMDS_MeshElement* e) const = 0;
-    ~Filter() {}
+    virtual ~Filter() {}
   };
   struct NonNullFilter: public Filter
   {
@@ -179,28 +179,19 @@ public:
     bool operator()(const SMDS_MeshElement* e) const { return e && e->GetGeomType() == _type; }
   };
 
-protected:
-  inline void setId(int id) {myID = id; }
-  inline void setShapeId(LongType shapeId) {myShapeId = shapeId; }
-  inline void setIdInShape(int id) { myIdInShape = id; }
-  inline void setVtkId(int vtkId) { myVtkID = vtkId; }
-  SMDS_MeshElement(int ID=-1);
-  SMDS_MeshElement(int id, ShortType meshId, LongType shapeId = 0);
-  virtual void init(int id = -1, ShortType meshId = -1, LongType shapeId = 0);
-  virtual void Print(std::ostream & OS) const;
-
-  //! Element index in vector SMDS_Mesh::myNodes or SMDS_Mesh::myCells
-  int myID;
-  //! index in vtkUnstructuredGrid
-  int myVtkID;
-  //! SMDS_Mesh identification in SMESH
-  ShortType myMeshId;
-  //! SubShape and SubMesh identification in SMESHDS
-  LongType myShapeId;
-  //! Element index in SMESHDS_SubMesh vector
-  int myIdInShape;
-};
+ protected:
+
+  SMDS_MeshElement();
+
+  void setVtkID(const vtkIdType vtkID );
+  virtual void setShapeID( const int shapeID ) const;
+
+  SMDS_UnstructuredGrid* getGrid() const;
 
+ protected:
+
+  SMDS_ElementChunk* myHolder;
+};
 
 // ============================================================
 /*!
@@ -208,9 +199,16 @@ protected:
  */
 // ============================================================
 
-struct TIDCompare {
+struct TIDTypeCompare {
   bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
   { return e1->GetType() == e2->GetType() ? e1->GetID() < e2->GetID() : e1->GetType() < e2->GetType(); }
 };
 
+// WARNING: this comparator makes impossible to store both nodes and elements in the same set
+// because there are nodes and elements with the same ID. Use TIDTypeCompare for such containers.
+struct TIDCompare {
+  bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
+  { return e1->GetID() < e2->GetID(); }
+};
+
 #endif