src/finiteVolume/fields/fvPatchFields/derived/fixedMeanValue/fixedMeanValueFvPatchField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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     fixedMeanValueFvPatchField
  27
  28 Description
  29
  30 SourceFiles
  31     fixedMeanValueFvPatchField.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef fixedMeanValueFvPatchField_H
  36 #define fixedMeanValueFvPatchField_H
  37
  38 #include "fixedValueFvPatchFields.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                Class fixedMeanValueFvPatchField Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 template<class Type>
  50 class fixedMeanValueFvPatchField
  51 :
  52     public fixedValueFvPatchField<Type>
  53 {
  54     // Private data
  55
  56         //- Mean value
  57         Type meanValue_;
  58
  59         //- Current time index
  60         label curTimeIndex_;
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("fixedMeanValue");
  67
  68
  69     // Constructors
  70
  71         //- Construct from patch and internal field
  72         fixedMeanValueFvPatchField
  73         (
  74             const fvPatch&,
  75             const DimensionedField<Type, volMesh>&
  76         );
  77
  78         //- Construct from patch, internal field and dictionary
  79         fixedMeanValueFvPatchField
  80         (
  81             const fvPatch&,
  82             const DimensionedField<Type, volMesh>&,
  83             const dictionary&
  84         );
  85
  86         //- Construct by mapping given fixedMeanValueFvPatchField
  87         //  onto a new patch
  88         fixedMeanValueFvPatchField
  89         (
  90             const fixedMeanValueFvPatchField<Type>&,
  91             const fvPatch&,
  92             const DimensionedField<Type, volMesh>&,
  93             const fvPatchFieldMapper&
  94         );
  95
  96         //- Construct and return a clone
  97         virtual tmp<fvPatchField<Type> > clone() const
  98         {
  99             return tmp<fvPatchField<Type> >
 100             (
 101                 new fixedMeanValueFvPatchField<Type>(*this)
 102             );
 103         }
 104
 105         //- Construct as copy setting internal field reference
 106         fixedMeanValueFvPatchField
 107         (
 108             const fixedMeanValueFvPatchField<Type>&,
 109             const DimensionedField<Type, volMesh>&
 110         );
 111
 112         //- Construct and return a clone setting internal field reference
 113         virtual tmp<fvPatchField<Type> > clone
 114         (
 115             const DimensionedField<Type, volMesh>& iF
 116         ) const
 117         {
 118             return tmp<fvPatchField<Type> >
 119             (
 120                 new fixedMeanValueFvPatchField<Type>(*this, iF)
 121             );
 122         }
 123
 124
 125     // Member functions
 126
 127         // Access
 128
 129             //- Return the ref value
 130             const Type& meanValue() const
 131             {
 132                 return meanValue_;
 133             }
 134
 135             //- Return reference to the ref value to allow adjustment
 136             Type& meanValue()
 137             {
 138                 return meanValue_;
 139             }
 140
 141
 142         // Mapping functions
 143
 144             //- Map (and resize as needed) from self given a mapping object
 145             virtual void autoMap
 146             (
 147                 const fvPatchFieldMapper&
 148             );
 149
 150             //- Reverse map the given fvPatchField onto this fvPatchField
 151             virtual void rmap
 152             (
 153                 const fvPatchField<Type>&,
 154                 const labelList&
 155             );
 156
 157
 158         // Evaluation functions
 159
 160             //- Update the coefficients associated with the patch field
 161             virtual void updateCoeffs();
 162
 163
 164         //- Write
 165         virtual void write(Ostream&) const;
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #ifdef NoRepository
 176 #   include "fixedMeanValueFvPatchField.C"
 177 #endif
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 #endif
 182
 183 // ************************************************************************* //