src/OpenFOAM/fields/Fields/Field/FieldMapper.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::FieldMapper
  26
  27 Description
  28     Abstract base class to hold the Field mapping addressing and weights.
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef FieldMapper_H
  33 #define FieldMapper_H
  34
  35 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  36
  37 namespace Foam
  38 {
  39
  40 /*---------------------------------------------------------------------------*\
  41                            Class FieldMapper Declaration
  42 \*---------------------------------------------------------------------------*/
  43
  44 class FieldMapper
  45 {
  46
  47 public:
  48
  49     // Constructors
  50
  51         //- Null constructor
  52         FieldMapper()
  53         {}
  54
  55
  56     //- Destructor
  57     virtual ~FieldMapper()
  58     {}
  59
  60
  61     // Member Functions
  62
  63         virtual label size() const = 0;
  64
  65         virtual bool direct() const = 0;
  66
  67         virtual const labelUList& directAddressing() const
  68         {
  69             FatalErrorIn("FieldMapper::directAddressing() const")
  70                 << "attempt to access null direct addressing"
  71                 << abort(FatalError);
  72
  73             return labelUList::null();
  74         }
  75
  76         virtual const labelListList& addressing() const
  77         {
  78             FatalErrorIn("FieldMapper::addressing() const")
  79                 << "attempt to access null interpolation addressing"
  80                 << abort(FatalError);
  81
  82             return labelListList::null();
  83         }
  84
  85         virtual const scalarListList& weights() const
  86         {
  87             FatalErrorIn("FieldMapper::weights() const")
  88                 << "attempt to access null interpolation weights"
  89                 << abort(FatalError);
  90
  91             return scalarListList::null();
  92         }
  93
  94
  95     // Member Operators
  96
  97         template<class Type>
  98         tmp<Field<Type> > operator()(const Field<Type>& f) const
  99         {
 100             return tmp<Field<Type> >(new Field<Type>(f, *this));
 101         }
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //