Salome HOME
Update copyrights
[tools/medcoupling.git] / src / ParaMEDMEM / ComponentTopology.hxx
1 // Copyright (C) 2007-2019  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef __COMPONENTTOPOLOGY_HXX__
21 #define __COMPONENTTOPOLOGY_HXX__
22
23 #include "Topology.hxx"
24
25 #include <vector>
26
27 namespace MEDCoupling
28 {
29   class ProcessorGroup;
30
31   /*!
32    * \anchor ComponentTopology-det
33    *
34    * The ComponentTopology can be used when building a ParaFIELD. It allows the splitting of the components
35    * of the field among different processors within a single processor group.
36    *
37    * \sa ParaFIELD::ParaFIELD(TypeOfField , TypeOfTimeDiscretization , ParaMESH* , const ComponentTopology& )
38    */
39   class ComponentTopology
40   {
41   public:
42     ComponentTopology(int nb_comp, ProcessorGroup* group);
43     ComponentTopology(int nb_comp, int nb_blocks);
44     ComponentTopology(int nb_comp);
45     ComponentTopology();
46     virtual ~ComponentTopology();
47     //!returns the number of MED components in the topology
48     int nbComponents() const { return _component_array.back(); }
49     //!returns the number of MED components on local processor
50     int nbLocalComponents() const ;
51     //!returns the number of the first MED component on local processor
52     int firstLocalComponent() const ;
53     //!returns the number of blocks in the topology
54     int nbBlocks()const {return _component_array.size()-1;}
55     //!returns the block structure
56     const std::vector<int>* getBlockIndices() const { return &_component_array; }
57     const ProcessorGroup* getProcGroup()const { return _proc_group; } 
58   private:
59     std::vector<int> _component_array;
60     ProcessorGroup* _proc_group;
61   };
62 }
63
64 #endif /*COMPONENTTOPOLOGY_HXX_*/