Salome HOME
- virtual SMDS_ElemIteratorPtr nodesIteratorToUNV() const;
[modules/smesh.git] / src / SMDS / SMDS_MeshElement.hxx
index 61631859cdf764f6cb71270a289f9a5125174ad2..a8a3ad4224f038efcf96ad34d21b539b19eb4c58 100644 (file)
-// File generated by CPPExt (Transient)
+// Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//                     Copyright (C) 1991,1995 by
-//  
-//                      MATRA DATAVISION, FRANCE
-//  
-// This software is furnished in accordance with the terms and conditions
-// of the contract and with the inclusion of the above copyright notice.
-// This software or any other copy thereof may not be provided or otherwise
-// be made available to any other person. No title to an ownership of the
-// software is hereby transferred.
-//  
-// At the termination of the contract, the software and all copies of this
-// software must be deleted.
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// 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.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+//  SMESH SMDS : implementaion of Salome mesh data structure
+//  File   : SMDS_MeshElement.hxx
+//  Module : SMESH
 //
 #ifndef _SMDS_MeshElement_HeaderFile
 #define _SMDS_MeshElement_HeaderFile
 
-#ifndef _Standard_HeaderFile
-#include <Standard.hxx>
-#endif
-#ifndef _Handle_SMDS_MeshElement_HeaderFile
-#include "Handle_SMDS_MeshElement.hxx"
-#endif
-
-#ifndef _Standard_Integer_HeaderFile
-#include <Standard_Integer.hxx>
-#endif
-#ifndef _SMDSAbs_ElementType_HeaderFile                                                                           
+#include "SMESH_SMDS.hxx"
+        
 #include "SMDSAbs_ElementType.hxx"
-#endif
-#ifndef _Handle_TColgp_HArray1OfDir_HeaderFile
-#include "Handle_TColgp_HArray1OfDir.hxx"
-#endif
-#ifndef _SMDS_MeshObject_HeaderFile
 #include "SMDS_MeshObject.hxx"
-#endif
-#ifndef _Standard_Boolean_HeaderFile
-#include <Standard_Boolean.hxx>
-#endif
-#ifndef _Standard_Address_HeaderFile
-#include <Standard_Address.hxx>
-#endif
-#ifndef _Standard_Real_HeaderFile
-#include <Standard_Real.hxx>
-#endif
-#ifndef _Standard_OStream_HeaderFile
-#include <Standard_OStream.hxx>
-#endif
-class TColgp_HArray1OfDir;
-class Standard_OutOfRange;
-class SMDS_ListOfMeshElement;
-class gp_Vec;
-class gp_Dir;
-
-
-class SMDS_MeshElement : public SMDS_MeshObject {
-
-public:
-
-    inline void* operator new(size_t,void* anAddress) 
-      {
-        return anAddress;
-      }
-    inline void* operator new(size_t size) 
-      { 
-        return Standard::Allocate(size); 
-      }
-    inline void  operator delete(void *anAddress) 
-      { 
-        if (anAddress) Standard::Free((Standard_Address&)anAddress); 
-      }
-//    inline void  operator delete(void *anAddress, size_t size) 
-//      { 
-//        if (anAddress) Standard::Free((Standard_Address&)anAddress,size); 
-//      }
- // Methods PUBLIC
- // 
-Standard_EXPORT inline   Standard_Integer HashCode(const Standard_Integer Upper) const;
-Standard_EXPORT inline   Standard_Boolean IsSame(const Handle(SMDS_MeshElement)& other) const;
-Standard_EXPORT inline   Standard_Boolean IsEqual(const Handle(SMDS_MeshElement)& other) const;
-Standard_EXPORT inline   Standard_Boolean IsNodeInElement(const Standard_Integer idnode) const;
-Standard_EXPORT virtual  void GetEdgeDefinedByNodes(const Standard_Integer rank,Standard_Integer& idnode1,Standard_Integer& idnode2) const;
-Standard_EXPORT virtual  void GetFaceDefinedByNodes(const Standard_Integer rank,const Standard_Address idnode,Standard_Integer& nb) const;
-Standard_EXPORT virtual  Standard_Integer GetConnection(const Standard_Integer rank) const;
-Standard_EXPORT virtual  void AddInverseElement(const Handle(SMDS_MeshElement)& ME) ;
-Standard_EXPORT virtual const SMDS_ListOfMeshElement& InverseElements() const;
-Standard_EXPORT virtual  void ClearInverseElements() ;
-Standard_EXPORT inline   Standard_Integer NbNodes() const;
-Standard_EXPORT virtual  Standard_Integer NbEdges() const;
-Standard_EXPORT virtual  Standard_Integer NbFaces() const;
-Standard_EXPORT inline   Standard_Integer GetID() const;
-Standard_EXPORT virtual  Standard_Integer GetKey() const = 0;
-Standard_EXPORT virtual  void SetNormal(const Standard_Integer rank,const Standard_Real vx,const Standard_Real vy,const Standard_Real vz) ;
-Standard_EXPORT virtual  void SetNormal(const Standard_Integer rank,const gp_Vec& v) ;
-Standard_EXPORT virtual  gp_Dir GetNormal(const Standard_Integer rank) ;
-Standard_EXPORT virtual  void Print(Standard_OStream& OS) const;
-friend Standard_EXPORT Standard_OStream& operator << (Standard_OStream& OS, const Handle(SMDS_MeshElement)& );
-Standard_EXPORT inline   SMDSAbs_ElementType GetType() const;
-Standard_EXPORT ~SMDS_MeshElement();
-
-
-
-
- // Type management
- //
- Standard_EXPORT friend Handle_Standard_Type& SMDS_MeshElement_Type_();
- Standard_EXPORT const Handle(Standard_Type)& DynamicType() const;
- Standard_EXPORT Standard_Boolean             IsKind(const Handle(Standard_Type)&) const;
-
-protected:
+#include "SMDS_ElemIterator.hxx"
+#include "SMDS_MeshElementIDFactory.hxx"
+#include "SMDS_StdIterator.hxx"
 
- // Methods PROTECTED
- // 
-Standard_EXPORT SMDS_MeshElement(const Standard_Integer ID,const Standard_Integer NbConnections,const SMDSAbs_ElementType Type);
-Standard_EXPORT virtual  Standard_Address GetConnections() const;
+#include <vector>
+#include <iostream>
 
+#include <vtkType.h>
+#include <vtkCellType.h>
 
- // Fields PROTECTED
- //
-Standard_Integer myID;
-Standard_Integer myNbNodes;
-Handle_TColgp_HArray1OfDir myNormals;
+//typedef unsigned short UShortType;
+typedef short ShortType;
+typedef int   LongType;
 
+class SMDS_MeshNode;
+class SMDS_MeshEdge;
+class SMDS_MeshFace;
+class SMDS_Mesh;
 
-private: 
+// ============================================================
+/*!
+ * \brief Base class for elements
+ */
+// ============================================================
 
- // Methods PRIVATE
- // 
 
+class SMDS_EXPORT SMDS_MeshElement:public SMDS_MeshObject
+{
+public:
 
- // Fields PRIVATE
- //
-SMDSAbs_ElementType myType;
-
+  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;
+
+  virtual SMDS_NodeIteratorPtr nodeIterator() const;
+  virtual SMDS_NodeIteratorPtr interlacedNodesIterator() const;
+  virtual SMDS_NodeIteratorPtr nodesIteratorToUNV() const;
+
+  // std-like iteration on nodes
+  typedef SMDS_StdIterator< const SMDS_MeshNode*, SMDS_ElemIteratorPtr > iterator;
+  iterator begin_nodes() const { return iterator( nodesIterator() ); }
+  iterator end_nodes()   const { return iterator(); }
+
+  virtual int NbNodes() const;
+  virtual int NbEdges() const;
+  virtual int NbFaces() const;
+  inline int GetID() const { return myID; };
+
+  ///Return the type of the current element
+  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 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;
+
+  // ===========================
+  //  Access to nodes by index
+  // ===========================
+  /*!
+   * \brief Return node by its index
+    * \param ind - node index
+    * \retval const SMDS_MeshNode* - the node
+   */
+  virtual const SMDS_MeshNode* GetNode(const int ind) const;
+
+  /*!
+   * \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
+   */
+  const SMDS_MeshNode* GetNodeWrap(const int ind) const { return GetNode( WrappedIndex( ind )); }
+
+  /*!
+   * \brief Return true if index of node is valid (0 <= ind < NbNodes())
+    * \param ind - node index
+    * \retval bool - index check result
+   */
+  virtual bool IsValidIndex(const int ind) const;
+
+  /*!
+   * \brief Return a valid 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;
+  }
+
+  /*!
+   * \brief Check if a node belongs to the element
+    * \param node - the node to check
+    * \retval int - node index within the element, -1 if not found
+   */
+  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; }
+
+  /*!
+   * \brief Filters of elements, to be used with SMDS_SetIterator
+   */
+  struct TypeFilter
+  {
+    SMDSAbs_ElementType _type;
+    TypeFilter( SMDSAbs_ElementType t = SMDSAbs_NbElementTypes ):_type(t) {}
+    bool operator()(const SMDS_MeshElement* e) const { return e && e->GetType() == _type; }
+  };
+  struct EntityFilter
+  {
+    SMDSAbs_EntityType _type;
+    EntityFilter( SMDSAbs_EntityType t = SMDSEntity_Last ):_type(t) {}
+    bool operator()(const SMDS_MeshElement* e) const { return e && e->GetEntityType() == _type; }
+  };
+  struct GeomFilter
+  {
+    SMDSAbs_GeometryType _type;
+    GeomFilter( SMDSAbs_GeometryType t = SMDSGeom_NONE ):_type(t) {}
+    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;
 };
 
 
-#include "SMDS_MeshElement.lxx"
-
-
-
-// other inline functions and methods (like "C++: function call" methods)
-//
+// ============================================================
+/*!
+ * \brief Comparator of elements by ID for usage in std containers
+ */
+// ============================================================
 
+struct TIDCompare {
+  bool operator () (const SMDS_MeshElement* e1, const SMDS_MeshElement* e2) const
+  { return e1->GetType() == e2->GetType() ? e1->GetID() < e2->GetID() : e1->GetType() < e2->GetType(); }
+};
 
 #endif