src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.C

   1 /*---------------------------------------------------------------------------* \
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 "SRFVelocityFvPatchVectorField.H"
  28 #include "addToRunTimeSelectionTable.H"
  29 #include "volFields.H"
  30
  31 #include "SRFModel.H"
  32
  33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  34
  35 namespace Foam
  36 {
  37
  38 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  39
  40 SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField
  41 (
  42     const fvPatch& p,
  43     const DimensionedField<vector, volMesh>& iF
  44 )
  45 :
  46     fixedValueFvPatchVectorField(p, iF),
  47     relative_(0),
  48     inletValue_(p.size(), vector::zero)
  49 {}
  50
  51
  52 SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField
  53 (
  54     const SRFVelocityFvPatchVectorField& ptf,
  55     const fvPatch& p,
  56     const DimensionedField<vector, volMesh>& iF,
  57     const fvPatchFieldMapper& mapper
  58 )
  59 :
  60     fixedValueFvPatchVectorField(ptf, p, iF, mapper),
  61     relative_(ptf.relative_),
  62     inletValue_(ptf.inletValue_, mapper)
  63 {}
  64
  65
  66 SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField
  67 (
  68     const fvPatch& p,
  69     const DimensionedField<vector, volMesh>& iF,
  70     const dictionary& dict
  71 )
  72 :
  73     fixedValueFvPatchVectorField(p, iF),
  74     relative_(dict.lookup("relative")),
  75     inletValue_("inletValue", dict, p.size())
  76 {
  77     fvPatchVectorField::operator=(vectorField("value", dict, p.size()));
  78 }
  79
  80
  81 SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField
  82 (
  83     const SRFVelocityFvPatchVectorField& srfvpvf
  84 )
  85 :
  86     fixedValueFvPatchVectorField(srfvpvf),
  87     relative_(srfvpvf.relative_),
  88     inletValue_(srfvpvf.inletValue_)
  89 {}
  90
  91
  92 SRFVelocityFvPatchVectorField::SRFVelocityFvPatchVectorField
  93 (
  94     const SRFVelocityFvPatchVectorField& srfvpvf,
  95     const DimensionedField<vector, volMesh>& iF
  96 )
  97 :
  98     fixedValueFvPatchVectorField(srfvpvf, iF),
  99     relative_(srfvpvf.relative_),
 100     inletValue_(srfvpvf.inletValue_)
 101 {}
 102
 103
 104 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 105
 106 void SRFVelocityFvPatchVectorField::autoMap
 107 (
 108     const fvPatchFieldMapper& m
 109 )
 110 {
 111     vectorField::autoMap(m);
 112     inletValue_.autoMap(m);
 113 }
 114
 115
 116 void SRFVelocityFvPatchVectorField::rmap
 117 (
 118     const fvPatchVectorField& ptf,
 119     const labelList& addr
 120 )
 121 {
 122     fixedValueFvPatchVectorField::rmap(ptf, addr);
 123
 124     const SRFVelocityFvPatchVectorField& tiptf =
 125         refCast<const SRFVelocityFvPatchVectorField>(ptf);
 126
 127     inletValue_.rmap(tiptf.inletValue_, addr);
 128 }
 129
 130
 131 void SRFVelocityFvPatchVectorField::updateCoeffs()
 132 {
 133     if (updated())
 134     {
 135         return;
 136     }
 137
 138     // If relative, include the effect of the SRF
 139     if (relative_)
 140     {
 141         // Get reference to the SRF model
 142         const SRF::SRFModel& srf =
 143             db().lookupObject<SRF::SRFModel>("SRFProperties");
 144
 145         // Determine patch velocity due to SRF
 146         const vectorField SRFVelocity = srf.velocity(patch().Cf());
 147
 148         operator==(-SRFVelocity + inletValue_);
 149     }
 150     // If absolute, simply supply the inlet value as a fixed value
 151     else
 152     {
 153         operator==(inletValue_);
 154     }
 155
 156     fixedValueFvPatchVectorField::updateCoeffs();
 157 }
 158
 159
 160 void SRFVelocityFvPatchVectorField::write(Ostream& os) const
 161 {
 162     fvPatchVectorField::write(os);
 163     os.writeKeyword("relative") << relative_ << token::END_STATEMENT << nl;
 164     inletValue_.writeEntry("inletValue", os);
 165     writeEntry("value", os);
 166 }
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 makePatchTypeField
 172 (
 173     fvPatchVectorField,
 174     SRFVelocityFvPatchVectorField
 175 );
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 } // End namespace Foam
 180
 181 // ************************************************************************* //