Salome HOME
Merge from BR_V5_DEV 16Feb09
[modules/smesh.git] / src / DriverMED / DriverMED_Family.h
1 //  Copyright (C) 2007-2008  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.
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 //  SMESH DriverMED : tool to split groups on families
23 //  File   : DriverMED_Family.hxx
24 //  Author : Julia DOROVSKIKH
25 //  Module : SMESH
26 //  $Header$
27 //
28 #ifndef _INCLUDE_DRIVERMED_FAMILY
29 #define _INCLUDE_DRIVERMED_FAMILY
30
31 #include "SMESH_DriverMED.hxx"
32
33 #include "SMDS_Mesh.hxx"
34 #include "SMESHDS_GroupBase.hxx"
35 #include "SMESHDS_SubMesh.hxx"
36 #include "MED_Common.hxx"
37
38 #include <boost/shared_ptr.hpp>
39 #include <set>
40
41 #define REST_NODES_FAMILY 1
42 #define REST_EDGES_FAMILY -1
43 #define REST_FACES_FAMILY -2
44 #define REST_VOLUMES_FAMILY -3
45 #define FIRST_NODE_FAMILY 2
46 #define FIRST_ELEM_FAMILY -4
47
48 class DriverMED_Family;
49 typedef boost::shared_ptr<DriverMED_Family> DriverMED_FamilyPtr;
50 typedef std::list<DriverMED_FamilyPtr> DriverMED_FamilyPtrList;
51 typedef std::map<int,SMESHDS_SubMesh*> SMESHDS_SubMeshPtrMap;
52 typedef std::list<SMESHDS_GroupBase*> SMESHDS_GroupBasePtrList;
53 typedef std::set<const SMDS_MeshElement*> ElementsSet;
54
55 class MESHDRIVERMED_EXPORT DriverMED_Family
56 {
57  public:
58
59   DriverMED_Family();
60
61   //! Methods for groups storing to MED
62   /*!
63     Split each group from list <theGroups> and each sub-mesh from list <theSubMeshes>
64     on some parts (families) on the basis of the elements membership in other groups
65     from <theGroups> and other sub-meshes from <theSubMeshes>.
66     Resulting families have no common elements.
67   */
68   static 
69   DriverMED_FamilyPtrList
70   MakeFamilies (const SMESHDS_SubMeshPtrMap& theSubMeshes,
71                 const SMESHDS_GroupBasePtrList& theGroups,
72                 const bool doGroupOfNodes,
73                 const bool doGroupOfEdges,
74                 const bool doGroupOfFaces,
75                 const bool doGroupOfVolumes);
76
77   //! Create TFamilyInfo for this family
78   MED::PFamilyInfo 
79   GetFamilyInfo (const MED::PWrapper& theWrapper, 
80                  const MED::PMeshInfo& theMeshInfo) const;
81
82   //! Returns elements of this family
83   const ElementsSet& GetElements () const;
84
85   //! Returns a family ID
86   int GetId () const;
87
88   //! Sets a family ID
89   void SetId (const int theId);
90
91  public:
92
93   // Methods for groups reading from MED
94
95   void AddElement(const SMDS_MeshElement* theElement);
96
97   const MED::TStringSet& GetGroupNames() const;
98   void AddGroupName(std::string theGroupName);
99
100   void SetType(const SMDSAbs_ElementType theType);
101   SMDSAbs_ElementType GetType();
102
103   bool MemberOf(std::string theGroupName) const;
104
105   int GetGroupAttributVal() const;
106   void SetGroupAttributVal( int theValue);
107
108  private:
109   //! Initialize the tool by SMESHDS_GroupBase
110   void Init (SMESHDS_GroupBase* group);
111
112   //! Split <theSubMesh> on some parts (families) on the basis of the elements type.
113   static
114   DriverMED_FamilyPtrList 
115   SplitByType(SMESHDS_SubMesh* theSubMesh,
116               const int        theId);
117
118
119   /*! Remove from <Elements> elements, common with <by>,
120     Remove from <by> elements, common with <Elements>,
121     Create family <common> from common elements, with combined groups list.
122   */
123   void Split (DriverMED_FamilyPtr by,
124               DriverMED_FamilyPtr common);
125
126   //! Check, if this family has empty list of elements
127   bool IsEmpty () const;
128
129
130  private:
131   int                           myId;
132   SMDSAbs_ElementType           myType;
133   ElementsSet                   myElements;
134   MED::TStringSet               myGroupNames;
135   int                           myGroupAttributVal;
136 };
137
138 #endif