Gather.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::Gather
26 
27 Description
28  Gather data from all processors onto all processors.
29 
30 SourceFiles
31  Gather.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef Gather_H
36 #define Gather_H
37 
38 #include "List.H"
39 #include "labelList.H"
40 #include "GatherBase.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class Gather Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class T0>
52 class Gather
53 :
54  public GatherBase,
55  public List<T0>
56 {
57  // Private data
58 
59  //- Number of processors (1 for sequential)
60  label nProcs_;
61 
62  //- Storage of type 0
63  //List<T0> data0_;
64 
65 public:
66 
67  // Constructors
68 
69  //- Construct from containers across processors
70  Gather(const T0&, const bool redistribute=true);
71 
72 
73  // Member Functions
74 
75 // const List<T0>& data0() const
76 // {
77 // return data0_;
78 // }
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #ifdef NoRepository
89  #include "Gather.C"
90 #endif
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
Foam::Gather::nProcs_
label nProcs_
Number of processors (1 for sequential)
Definition: Gather.H:59
List.H
GatherBase.H
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
labelList.H
Foam::GatherBase
Definition: GatherBase.H:48
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::Gather::Gather
Gather(const T0 &, const bool redistribute=true)
Storage of type 0.
Definition: Gather.C:41
Gather.C
Foam::Gather
Gather data from all processors onto all processors.
Definition: Gather.H:51