src/finiteVolume/fields/fvPatchFields/derived/flux/fluxFvPatchField.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 "fluxFvPatchField.H"
  28
  29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  30
  31 namespace Foam
  32 {
  33
  34 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  35
  36 template<class Type>
  37 fluxFvPatchField<Type>::fluxFvPatchField
  38 (
  39     const fvPatch& p,
  40     const DimensionedField<Type, volMesh>& iF
  41 )
  42 :
  43     fixedGradientFvPatchField<Type>(p, iF),
  44     reactivity_(0),
  45     gammaName_("gamma")
  46 {
  47     this->gradient() = pTraits<Type>::zero;
  48 }
  49
  50
  51 template<class Type>
  52 fluxFvPatchField<Type>::fluxFvPatchField
  53 (
  54     const fluxFvPatchField<Type>& ptf,
  55     const fvPatch& p,
  56     const DimensionedField<Type, volMesh>& iF,
  57     const fvPatchFieldMapper& mapper
  58 )
  59 :
  60     fixedGradientFvPatchField<Type>(ptf, p, iF, mapper),
  61     reactivity_(ptf.reactivity_),
  62     gammaName_(ptf.gammaName_)
  63 {}
  64
  65
  66 template<class Type>
  67 fluxFvPatchField<Type>::fluxFvPatchField
  68 (
  69     const fvPatch& p,
  70     const DimensionedField<Type, volMesh>& iF,
  71     const dictionary& dict
  72 )
  73 :
  74     fixedGradientFvPatchField<Type>(p, iF),
  75     reactivity_(readScalar(dict.lookup("reactivity"))),
  76     gammaName_(dict.lookup("gamma"))
  77 {
  78     // Set dummy gradient
  79     this->gradient() = pTraits<Type>::zero;
  80
  81     // Read the value entry from the dictionary
  82     if (dict.found("value"))
  83     {
  84         fvPatchField<Type>::operator=
  85         (
  86             Field<Type>("value", dict, p.size())
  87         );
  88     }
  89     else
  90     {
  91         FatalIOErrorIn
  92         (
  93             "fluxFvPatchField<Type>::fluxFvPatchField"
  94             "("
  95             "const fvPatch& p,"
  96             "const DimensionedField<Type, volMesh>& iF,"
  97             "const dictionary& dict,"
  98             "const bool valueRequired"
  99             ")",
 100             dict
 101         )   << "Essential entry 'value' missing"
 102             << exit(FatalIOError);
 103     }
 104 }
 105
 106
 107 template<class Type>
 108 fluxFvPatchField<Type>::fluxFvPatchField
 109 (
 110     const fluxFvPatchField<Type>& ptf
 111 )
 112 :
 113     fixedGradientFvPatchField<Type>(ptf),
 114     reactivity_(ptf.reactivity_),
 115     gammaName_(ptf.gammaName_)
 116 {}
 117
 118
 119 template<class Type>
 120 fluxFvPatchField<Type>::fluxFvPatchField
 121 (
 122     const fluxFvPatchField<Type>& ptf,
 123     const DimensionedField<Type, volMesh>& iF
 124 )
 125 :
 126     fixedGradientFvPatchField<Type>(ptf, iF),
 127     reactivity_(ptf.reactivity_),
 128     gammaName_(ptf.gammaName_)
 129 {}
 130
 131
 132 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 133
 134 template<class Type>
 135 void fluxFvPatchField<Type>::updateCoeffs()
 136 {
 137     if (this->updated())
 138     {
 139         return;
 140     }
 141
 142     const Field<Type>& C = *this;
 143
 144     const fvPatchField<scalar>& gammap =
 145         this->patch().lookupPatchField
 146         (
 147             gammaName_,
 148             reinterpret_cast<const volScalarField*>(NULL),
 149             reinterpret_cast<const scalar*>(NULL)
 150         );
 151
 152     this->gradient() = reactivity_*C/gammap;
 153
 154     fixedGradientFvPatchField<Type>::updateCoeffs();
 155 }
 156
 157
 158 template<class Type>
 159 void fluxFvPatchField<Type>::write(Ostream& os) const
 160 {
 161     fixedGradientFvPatchField<Type>::write(os);
 162     os.writeKeyword("reactivity")
 163         << reactivity_ << token::END_STATEMENT << nl;
 164     os.writeKeyword("gamma")
 165         << gammaName_ << token::END_STATEMENT << nl;
 166     this->writeEntry("value", os);
 167 }
 168
 169
 170 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 171
 172 } // End namespace Foam
 173
 174 // ************************************************************************* //