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

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "fixedMeanValueFvPatchField.H"
  28 #include "mathematicalConstants.H"
  29
  30 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  31
  32 namespace Foam
  33 {
  34
  35 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  36
  37 template<class Type>
  38 fixedMeanValueFvPatchField<Type>::fixedMeanValueFvPatchField
  39 (
  40     const fvPatch& p,
  41     const DimensionedField<Type, volMesh>& iF
  42 )
  43 :
  44     fixedValueFvPatchField<Type>(p, iF),
  45     meanValue_(pTraits<Type>::zero),
  46     curTimeIndex_(-1)
  47 {}
  48
  49
  50 template<class Type>
  51 fixedMeanValueFvPatchField<Type>::fixedMeanValueFvPatchField
  52 (
  53     const fixedMeanValueFvPatchField<Type>& ptf,
  54     const fvPatch& p,
  55     const DimensionedField<Type, volMesh>& iF,
  56     const fvPatchFieldMapper& mapper
  57 )
  58 :
  59     fixedValueFvPatchField<Type>(ptf, p, iF, mapper),
  60     meanValue_(ptf.meanValue_),
  61     curTimeIndex_(-1)
  62 {}
  63
  64
  65 template<class Type>
  66 fixedMeanValueFvPatchField<Type>::fixedMeanValueFvPatchField
  67 (
  68     const fvPatch& p,
  69     const DimensionedField<Type, volMesh>& iF,
  70     const dictionary& dict
  71 )
  72 :
  73     fixedValueFvPatchField<Type>(p, iF),
  74     meanValue_(pTraits<Type>(dict.lookup("meanValue"))),
  75     curTimeIndex_(-1)
  76 {
  77     if (dict.found("value"))
  78     {
  79         fixedValueFvPatchField<Type>::operator==
  80         (
  81             Field<Type>("value", dict, p.size())
  82         );
  83     }
  84     else
  85     {
  86         fixedValueFvPatchField<Type>::operator==(meanValue_);
  87     }
  88 }
  89
  90
  91 template<class Type>
  92 fixedMeanValueFvPatchField<Type>::fixedMeanValueFvPatchField
  93 (
  94     const fixedMeanValueFvPatchField<Type>& ptf,
  95     const DimensionedField<Type, volMesh>& iF
  96 )
  97 :
  98     fixedValueFvPatchField<Type>(ptf, iF),
  99     meanValue_(ptf.meanValue_),
 100     curTimeIndex_(-1)
 101 {}
 102
 103
 104 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 105
 106 // Map from self
 107 template<class Type>
 108 void fixedMeanValueFvPatchField<Type>::autoMap
 109 (
 110     const fvPatchFieldMapper& m
 111 )
 112 {
 113     Field<Type>::autoMap(m);
 114 }
 115
 116
 117 // Reverse-map the given fvPatchField onto this fvPatchField
 118 template<class Type>
 119 void fixedMeanValueFvPatchField<Type>::rmap
 120 (
 121     const fvPatchField<Type>& ptf,
 122     const labelList& addr
 123 )
 124 {
 125     fixedValueFvPatchField<Type>::rmap(ptf, addr);
 126 }
 127
 128
 129 // Update the coefficients associated with the patch field
 130 template<class Type>
 131 void fixedMeanValueFvPatchField<Type>::updateCoeffs()
 132 {
 133     if (this->updated())
 134     {
 135         return;
 136     }
 137
 138     if (curTimeIndex_ != this->db().time().timeIndex())
 139     {
 140         Field<Type>& patchField = *this;
 141
 142         Field<Type> pif = this->patchInternalField();
 143
 144         patchField = meanValue_ - gAverage(pif) + pif;
 145
 146         curTimeIndex_ = this->db().time().timeIndex();
 147     }
 148
 149     fixedValueFvPatchField<Type>::updateCoeffs();
 150 }
 151
 152
 153 // Write
 154 template<class Type>
 155 void fixedMeanValueFvPatchField<Type>::write(Ostream& os) const
 156 {
 157     fvPatchField<Type>::write(os);
 158     os.writeKeyword("meanValue")
 159         << meanValue_ << token::END_STATEMENT << nl;
 160     this->writeEntry("value", os);
 161 }
 162
 163
 164 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 165
 166 } // End namespace Foam
 167
 168 // ************************************************************************* //