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