src/engine/derivedFvPatchFields/engineMassFlowRateInletVelocity/engineMassFlowRateInletVelocityFvPatchVectorField.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 "engineMassFlowRateInletVelocityFvPatchVectorField.H"
  28 #include "volFields.H"
  29 #include "addToRunTimeSelectionTable.H"
  30 #include "fvPatchFieldMapper.H"
  31 #include "surfaceFields.H"
  32 #include "graph.H"
  33 #include "interpolateXY.H"
  34 #include "IFstream.H"
  35
  36 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  37
  38 Foam::
  39 engineMassFlowRateInletVelocityFvPatchVectorField::
  40 engineMassFlowRateInletVelocityFvPatchVectorField
  41 (
  42     const fvPatch& p,
  43     const DimensionedField<vector, volMesh>& iF
  44 )
  45 :
  46     fixedValueFvPatchField<vector>(p, iF),
  47     phiName_("phi"),
  48     rhoName_("rho"),
  49     timeDataPtr_(NULL),
  50     engineDB_((refCast<const engineTime>(this->db().time())))
  51 {}
  52
  53 Foam::
  54 engineMassFlowRateInletVelocityFvPatchVectorField::
  55 engineMassFlowRateInletVelocityFvPatchVectorField
  56 (
  57     const engineMassFlowRateInletVelocityFvPatchVectorField& ptf,
  58     const fvPatch& p,
  59     const DimensionedField<vector, volMesh>& iF,
  60     const fvPatchFieldMapper& mapper
  61 )
  62 :
  63     fixedValueFvPatchField<vector>(ptf, p, iF, mapper),
  64     phiName_(ptf.phiName_),
  65     rhoName_(ptf.rhoName_),
  66     timeDataFileName_(ptf.timeDataFileName_),
  67     timeDataPtr_(NULL),
  68     engineDB_((refCast<const engineTime>(this->db().time())))
  69 {}
  70
  71 Foam::
  72 engineMassFlowRateInletVelocityFvPatchVectorField::
  73 engineMassFlowRateInletVelocityFvPatchVectorField
  74 (
  75     const fvPatch& p,
  76     const DimensionedField<vector, volMesh>& iF,
  77     const dictionary& dict
  78 )
  79 :
  80     fixedValueFvPatchField<vector>(p, iF, dict),
  81     phiName_("phi"),
  82     rhoName_("rho"),
  83     timeDataFileName_(fileName(dict.lookup("timeDataFileName")).expand()),
  84     timeDataPtr_(NULL),
  85     engineDB_((refCast<const engineTime>(this->db().time())))
  86 {
  87     if (dict.found("phi"))
  88     {
  89         dict.lookup("phi") >> phiName_;
  90     }
  91
  92     if (dict.found("rho"))
  93     {
  94         dict.lookup("rho") >> rhoName_;
  95     }
  96 }
  97
  98 Foam::
  99 engineMassFlowRateInletVelocityFvPatchVectorField::
 100 engineMassFlowRateInletVelocityFvPatchVectorField
 101 (
 102     const engineMassFlowRateInletVelocityFvPatchVectorField& ptf
 103 )
 104 :
 105     fixedValueFvPatchField<vector>(ptf),
 106     phiName_(ptf.phiName_),
 107     rhoName_(ptf.rhoName_),
 108     timeDataFileName_(ptf.timeDataFileName_),
 109     timeDataPtr_(NULL),
 110     engineDB_((refCast<const engineTime>(this->db().time())))
 111 {}
 112
 113 Foam::
 114 engineMassFlowRateInletVelocityFvPatchVectorField::
 115 engineMassFlowRateInletVelocityFvPatchVectorField
 116 (
 117     const engineMassFlowRateInletVelocityFvPatchVectorField& ptf,
 118     const DimensionedField<vector, volMesh>& iF
 119 )
 120 :
 121     fixedValueFvPatchField<vector>(ptf, iF),
 122     phiName_(ptf.phiName_),
 123     rhoName_(ptf.rhoName_),
 124     timeDataFileName_(ptf.timeDataFileName_),
 125     timeDataPtr_(NULL),
 126     engineDB_((refCast<const engineTime>(this->db().time())))
 127 {}
 128
 129
 130 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 131
 132 void Foam::engineMassFlowRateInletVelocityFvPatchVectorField::checkTable()
 133 {
 134     if (!timeDataPtr_.valid())
 135     {
 136         timeDataPtr_.reset
 137         (
 138             new graph("title", "x", "y", IFstream(timeDataFileName_)())
 139         );
 140     }
 141
 142     if (engineDB_.theta() < min(timeDataPtr_().x()))
 143     {
 144         WarningIn
 145         (
 146             "engineTimeVaryingUniformFixedValueFvPatchField<Type>::updateCoeffs()"
 147         )   << "current time (" << engineDB_.theta()
 148             << ") is less than the minimum in the data table ("
 149             << min(timeDataPtr_().x()) << ')' << endl
 150             << "    Continuing with the value for the smallest time"
 151             << endl;
 152     }
 153
 154     if (engineDB_.theta() < min(timeDataPtr_().x()))
 155     {
 156         WarningIn
 157         (
 158             "engineTimeVaryingUniformFixedValueFvPatchField<Type>::updateCoeffs()"
 159         )   << "current time (" << engineDB_.theta()
 160             << ") is greater than the maximum in the data table ("
 161             << max(timeDataPtr_().x()) << ')' << endl
 162             << "    Continuing with the value for the largest time"
 163             << endl;
 164     }
 165 }
 166
 167
 168
 169
 170 void Foam::engineMassFlowRateInletVelocityFvPatchVectorField::updateCoeffs()
 171 {
 172     if (updated())
 173     {
 174         return;
 175     }
 176
 177     // a simpler way of doing this would be nice
 178     checkTable();
 179
 180     scalar massFlowRate =
 181     (
 182         interpolateXY
 183         (
 184             engineDB_.theta(),
 185             timeDataPtr_().x(),
 186             timeDataPtr_().y()
 187         )
 188     );
 189
 190
 191     scalar avgU = -massFlowRate/gSum(patch().magSf());
 192
 193     vectorField n = patch().nf();
 194
 195     const surfaceScalarField& phi = db().lookupObject<surfaceScalarField>
 196     (
 197         phiName_
 198     );
 199
 200     if (phi.dimensions() == dimVelocity*dimArea)
 201     {
 202         // volumetric flow-rate
 203         operator==(n*avgU);
 204     }
 205     else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
 206     {
 207         const fvPatchField<scalar>& rhop =
 208             patch().lookupPatchField<volScalarField, scalar>(rhoName_);
 209
 210         // mass flow-rate
 211         operator==(n*avgU/rhop);
 212     }
 213     else
 214     {
 215         FatalErrorIn
 216         (
 217             "engineMassFlowRateInletVelocityFvPatchVectorField::updateCoeffs()"
 218         )   << "dimensions of phi are incorrect"
 219             << "\n    on patch " << this->patch().name()
 220             << " of field " << this->dimensionedInternalField().name()
 221             << " in file " << this->dimensionedInternalField().objectPath()
 222             << exit(FatalError);
 223     }
 224
 225     fixedValueFvPatchField<vector>::updateCoeffs();
 226 }
 227
 228
 229 void Foam::engineMassFlowRateInletVelocityFvPatchVectorField::write(Ostream& os) const
 230 {
 231     fvPatchField<vector>::write(os);
 232
 233     if (phiName_ != "phi")
 234     {
 235         os.writeKeyword("phi") << phiName_ << token::END_STATEMENT << nl;
 236     }
 237
 238     if (rhoName_ != "rho")
 239     {
 240         os.writeKeyword("rho") << rhoName_ << token::END_STATEMENT << nl;
 241     }
 242
 243     os.writeKeyword("timeDataFileName")
 244         << timeDataFileName_ << token::END_STATEMENT << nl;
 245
 246     writeEntry("value", os);
 247 }
 248
 249
 250 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 251
 252 namespace Foam
 253 {
 254    makePatchTypeField
 255    (
 256        fvPatchVectorField,
 257        engineMassFlowRateInletVelocityFvPatchVectorField
 258    );
 259 }
 260
 261
 262 // ************************************************************************* //