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