applications/test/router/Gather/GatherBase.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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::GatherBase
  26
  27 Description
  28
  29 SourceFiles
  30     GatherBase.C
  31
  32 \*---------------------------------------------------------------------------*/
  33
  34 #ifndef GatherBase_H
  35 #define GatherBase_H
  36
  37 #include "List.H"
  38 #include "labelList.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class GatherBase Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class GatherBase
  50 {
  51
  52 public:
  53
  54         //- Flatten: appends all elements of list into one single list.
  55         //  Used to collapse 'Gathered' data.
  56         template <class T>
  57         static T flatten(const List<T>);
  58
  59         //- Flatten and offset 'Gathered' indices (into value) so they
  60         //  remain valid with respect to values (after they have been flattened)
  61         template <class DataType, class IndexType, class AddOp>
  62         static IndexType offset
  63         (
  64             const List<DataType>& values,
  65             const List<IndexType>& indices,
  66             AddOp aop
  67         );
  68 };
  69
  70
  71 template <class T>
  72 class AddOp
  73 {
  74
  75 public:
  76
  77     T operator()
  78     (
  79         const T& x,
  80         const label offset
  81     ) const
  82     {
  83         return x + offset;
  84     }
  85 };
  86
  87
  88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  89
  90 } // End namespace Foam
  91
  92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  93
  94 #ifdef NoRepository
  95 #   include "GatherBase.C"
  96 #endif
  97
  98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  99
 100 #endif
 101
 102 // ************************************************************************* //