Salome HOME
Copyright update 2021
[modules/smesh.git] / src / SMESHDS / SMESHDS_SubMesh.hxx
1 // Copyright (C) 2007-2021  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, or (at your option) any later version.
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 //  SMESH SMESHDS : management of mesh data and SMESH document
24 //  File   : SMESHDS_SubMesh.hxx
25 //  Module : SMESH
26 //
27 #ifndef _SMESHDS_SubMesh_HeaderFile
28 #define _SMESHDS_SubMesh_HeaderFile
29
30 #include "SMESH_SMESHDS.hxx"
31
32 #include "SMDS_ElementHolder.hxx"
33 #include "SMDS_Mesh.hxx"
34 #include <vector>
35
36 #include <boost/container/flat_set.hpp>
37 class SMESHDS_SubMesh;
38 typedef boost::container::flat_set< const SMESHDS_SubMesh* > TSubMeshSet;
39
40 class SMESHDS_SubMesh;
41 typedef SMDS_Iterator<const SMESHDS_SubMesh*> SMESHDS_SubMeshIterator;
42 typedef boost::shared_ptr< SMESHDS_SubMeshIterator > SMESHDS_SubMeshIteratorPtr;
43
44 class SMESHDS_Mesh;
45
46 class SMESHDS_EXPORT SMESHDS_SubMesh : public SMDS_ElementHolder
47 {
48  public:
49   SMESHDS_SubMesh(const SMESHDS_Mesh *parent, int index);
50   virtual ~SMESHDS_SubMesh();
51
52   virtual bool IsComplexSubmesh() const { return !mySubMeshes.empty(); }
53
54   // if !IsComplexSubmesh()
55   virtual void AddElement(const SMDS_MeshElement * ME);
56   virtual bool RemoveElement(const SMDS_MeshElement * ME); // ret true if ME was in
57   virtual void AddNode(const SMDS_MeshNode * ME);
58   virtual bool RemoveNode(const SMDS_MeshNode * ME);       // ret true if ME was in
59
60   // if IsComplexSubmesh()
61   void AddSubMesh( const SMESHDS_SubMesh* theSubMesh );
62   bool RemoveSubMesh( const SMESHDS_SubMesh* theSubMesh );
63   void RemoveAllSubmeshes();
64   bool ContainsSubMesh( const SMESHDS_SubMesh* theSubMesh ) const;
65   int  NbSubMeshes() const { return mySubMeshes.size(); }
66   SMESHDS_SubMeshIteratorPtr GetSubMeshIterator() const;
67
68   // for both types
69   virtual int NbElements() const;
70   virtual int NbNodes() const;
71   virtual SMDS_ElemIteratorPtr GetElements() const;
72   virtual SMDS_NodeIteratorPtr GetNodes() const;
73   virtual bool Contains(const SMDS_MeshElement * ME) const;      // check if elem or node is in
74   virtual bool IsQuadratic() const;
75
76   // clear the contents
77   virtual void Clear();
78
79   SMESHDS_Mesh* GetParent() const { return const_cast< SMESHDS_Mesh*>( myParent ); }
80   int           GetID()     const { return myIndex; }
81
82  protected: // methods of SMDS_ElementHolder
83
84   virtual SMDS_ElemIteratorPtr getElements();
85   virtual void tmpClear();
86   virtual void add( const SMDS_MeshElement* element );
87   virtual void compact() {}
88
89  private:
90
91   int                     myIndex;
92   int                     myNbElements;
93   int                     myNbNodes;
94   const SMDS_MeshElement* my1stElemNode[2]; // elem and node with least ID, to optimize iteration
95   const SMESHDS_Mesh *    myParent;
96   TSubMeshSet             mySubMeshes;
97
98 };
99 #endif