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