applications/test/router/Gather/Gather.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::Gather
  27
  28 Description
  29     Gather data from all processors onto all processors.
  30
  31 SourceFiles
  32     Gather.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef Gather_H
  37 #define Gather_H
  38
  39 #include "List.H"
  40 #include "labelList.H"
  41 #include "GatherBase.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class Gather Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 template <class T0>
  53 class Gather
  54 :
  55     public GatherBase,
  56     public List<T0>
  57 {
  58     // Private data
  59
  60         //- Number of processors (1 for sequential)
  61         label nProcs_;
  62
  63         //- Storage of type 0
  64         //List<T0> data0_;
  65
  66 public:
  67
  68     // Constructors
  69
  70         //- Construct from containers across processors
  71         Gather(const T0&, const bool redistribute=true);
  72
  73
  74     // Member Functions
  75
  76 //        const List<T0>& data0() const
  77 //        {
  78 //            return data0_;
  79 //        }
  80 };
  81
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 } // End namespace Foam
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #ifdef NoRepository
  90 #   include "Gather.C"
  91 #endif
  92
  93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  94
  95 #endif
  96
  97 // ************************************************************************* //