applications/solvers/coupled/conjugateHeatTransfer/fvPatchFields/fieldStorage/fieldStorage.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     fieldStorage
  26
  27 Description
  28     Region couple patch field
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     fieldStorage.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef fieldStorage_H
  39 #define fieldStorage_H
  40
  41 #include "coupledFvPatchField.H"
  42 #include "fvPatchFieldMapper.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                   Class fieldStorage Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class Type>
  54 class fieldStorage
  55 {
  56     // Private data
  57
  58         // Reference to time
  59         const runTime& time_;
  60
  61         //- original patch field
  62         Field<Type> storedField_;
  63
  64         //- Current time index used to store originalPatchField_
  65         label curTimeIndex_;
  66
  67
  68 public:
  69
  70     // Constructors
  71
  72         //- Construct from patch and internal field
  73         fieldStorage();
  74
  75     // Member functions
  76
  77         //- Store field
  78         void store(const Field<Type>&) const;
  79
  80         //- Return stored field
  81         const Field<Type>& originalPatchField() const;
  82
  83         //- Map (and resize as needed) from self given a mapping object
  84         void autoMap
  85         (
  86             const fvPatchFieldMapper&
  87         );
  88
  89         //- Reverse map the given fvPatchField onto this fvPatchField
  90         void rmap
  91         (
  92             const fvPatchField<Type>&,
  93             const labelList&
  94         );
  95
  96         //- Clear storage
  97         void clear() const;
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #ifdef NoRepository
 108 #   include "fieldStorage.C"
 109 #endif
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #endif
 114
 115 // ************************************************************************* //