src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.C

   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 \*---------------------------------------------------------------------------*/
  26
  27 #include "turbulentInletFvPatchField.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33
  34 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  35
  36 template<class Type>
  37 turbulentInletFvPatchField<Type>::turbulentInletFvPatchField
  38 (
  39     const fvPatch& p,
  40     const DimensionedField<Type, volMesh>& iF
  41 )
  42 :
  43     fixedValueFvPatchField<Type>(p, iF),
  44     ranGen_(label(0)),
  45     fluctuationScale_(pTraits<Type>::zero),
  46     referenceField_(p.size()),
  47     alpha_(0.1),
  48     curTimeIndex_(-1)
  49 {}
  50
  51
  52 template<class Type>
  53 turbulentInletFvPatchField<Type>::turbulentInletFvPatchField
  54 (
  55     const turbulentInletFvPatchField<Type>& ptf,
  56     const fvPatch& p,
  57     const DimensionedField<Type, volMesh>& iF,
  58     const fvPatchFieldMapper& mapper
  59 )
  60 :
  61     fixedValueFvPatchField<Type>(ptf, p, iF, mapper),
  62     ranGen_(label(0)),
  63     fluctuationScale_(ptf.fluctuationScale_),
  64     referenceField_(ptf.referenceField_, mapper),
  65     alpha_(ptf.alpha_),
  66     curTimeIndex_(-1)
  67 {}
  68
  69
  70 template<class Type>
  71 turbulentInletFvPatchField<Type>::turbulentInletFvPatchField
  72 (
  73     const fvPatch& p,
  74     const DimensionedField<Type, volMesh>& iF,
  75     const dictionary& dict
  76 )
  77 :
  78     fixedValueFvPatchField<Type>(p, iF),
  79     ranGen_(label(0)),
  80     fluctuationScale_(pTraits<Type>(dict.lookup("fluctuationScale"))),
  81     referenceField_("referenceField", dict, p.size()),
  82     alpha_(dict.lookupOrDefault<scalar>("alpha", 0.1)),
  83     curTimeIndex_(-1)
  84 {
  85     if (dict.found("value"))
  86     {
  87         fixedValueFvPatchField<Type>::operator==
  88         (
  89             Field<Type>("value", dict, p.size())
  90         );
  91     }
  92     else
  93     {
  94         fixedValueFvPatchField<Type>::operator==(referenceField_);
  95     }
  96 }
  97
  98
  99 template<class Type>
 100 turbulentInletFvPatchField<Type>::turbulentInletFvPatchField
 101 (
 102     const turbulentInletFvPatchField<Type>& ptf
 103 )
 104 :
 105     fixedValueFvPatchField<Type>(ptf),
 106     ranGen_(ptf.ranGen_),
 107     fluctuationScale_(ptf.fluctuationScale_),
 108     referenceField_(ptf.referenceField_),
 109     alpha_(ptf.alpha_),
 110     curTimeIndex_(-1)
 111 {}
 112
 113
 114 template<class Type>
 115 turbulentInletFvPatchField<Type>::turbulentInletFvPatchField
 116 (
 117     const turbulentInletFvPatchField<Type>& ptf,
 118     const DimensionedField<Type, volMesh>& iF
 119 )
 120 :
 121     fixedValueFvPatchField<Type>(ptf, iF),
 122     ranGen_(ptf.ranGen_),
 123     fluctuationScale_(ptf.fluctuationScale_),
 124     referenceField_(ptf.referenceField_),
 125     alpha_(ptf.alpha_),
 126     curTimeIndex_(-1)
 127 {}
 128
 129
 130 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 131
 132 template<class Type>
 133 void turbulentInletFvPatchField<Type>::autoMap
 134 (
 135     const fvPatchFieldMapper& m
 136 )
 137 {
 138     fixedValueFvPatchField<Type>::autoMap(m);
 139     referenceField_.autoMap(m);
 140 }
 141
 142
 143 template<class Type>
 144 void turbulentInletFvPatchField<Type>::rmap
 145 (
 146     const fvPatchField<Type>& ptf,
 147     const labelList& addr
 148 )
 149 {
 150     fixedValueFvPatchField<Type>::rmap(ptf, addr);
 151
 152     const turbulentInletFvPatchField<Type>& tiptf =
 153         refCast<const turbulentInletFvPatchField<Type> >(ptf);
 154
 155     referenceField_.rmap(tiptf.referenceField_, addr);
 156 }
 157
 158
 159 template<class Type>
 160 void turbulentInletFvPatchField<Type>::updateCoeffs()
 161 {
 162     if (this->updated())
 163     {
 164         return;
 165     }
 166
 167     if (curTimeIndex_ != this->db().time().timeIndex())
 168     {
 169         Field<Type>& patchField = *this;
 170
 171         Field<Type> randomField(this->size());
 172
 173         forAll(patchField, facei)
 174         {
 175             ranGen_.randomise(randomField[facei]);
 176         }
 177
 178         // Correction-factor proposed by Yi Wang to compensate for the loss
 179         // of RMS fluctuation due to the temporal correlation introduced by
 180         // the alpha parameter.
 181         scalar rmsCorr = sqrt(12*(2*alpha_ - sqr(alpha_)))/alpha_;
 182
 183         patchField =
 184             (1 - alpha_)*patchField
 185           + alpha_*
 186             (
 187                 referenceField_
 188               + rmsCorr*cmptMultiply
 189                 (
 190                     randomField - 0.5*pTraits<Type>::one,
 191                     fluctuationScale_
 192                 )*mag(referenceField_)
 193             );
 194
 195         curTimeIndex_ = this->db().time().timeIndex();
 196     }
 197
 198     fixedValueFvPatchField<Type>::updateCoeffs();
 199 }
 200
 201
 202 template<class Type>
 203 void turbulentInletFvPatchField<Type>::write(Ostream& os) const
 204 {
 205     fvPatchField<Type>::write(os);
 206     os.writeKeyword("fluctuationScale")
 207         << fluctuationScale_ << token::END_STATEMENT << nl;
 208     referenceField_.writeEntry("referenceField", os);
 209     this->writeEntry("value", os);
 210 }
 211
 212
 213 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 214
 215 } // End namespace Foam
 216
 217 // ************************************************************************* //