src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2006-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 "turbulentIntensityKineticEnergyInletFvPatchScalarField.H"
  28 #include "addToRunTimeSelectionTable.H"
  29 #include "fvPatchFieldMapper.H"
  30 #include "surfaceFields.H"
  31 #include "volFields.H"
  32
  33 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  34
  35 Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::
  36 turbulentIntensityKineticEnergyInletFvPatchScalarField
  37 (
  38     const fvPatch& p,
  39     const DimensionedField<scalar, volMesh>& iF
  40 )
  41 :
  42     fixedValueFvPatchField<scalar>(p, iF),
  43     intensity_(0.05)
  44 {}
  45
  46 Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::
  47 turbulentIntensityKineticEnergyInletFvPatchScalarField
  48 (
  49     const turbulentIntensityKineticEnergyInletFvPatchScalarField& ptf,
  50     const fvPatch& p,
  51     const DimensionedField<scalar, volMesh>& iF,
  52     const fvPatchFieldMapper& mapper
  53 )
  54 :
  55     fixedValueFvPatchField<scalar>(ptf, p, iF, mapper),
  56     intensity_(ptf.intensity_)
  57 {}
  58
  59 Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::
  60 turbulentIntensityKineticEnergyInletFvPatchScalarField
  61 (
  62     const fvPatch& p,
  63     const DimensionedField<scalar, volMesh>& iF,
  64     const dictionary& dict
  65 )
  66 :
  67     fixedValueFvPatchField<scalar>(p, iF, dict),
  68     intensity_(readScalar(dict.lookup("intensity")))
  69 {
  70     if (intensity_ < 0 || intensity_ > 1)
  71     {
  72         FatalErrorIn
  73         (
  74             "turbulentIntensityKineticEnergyInletFvPatchScalarField::"
  75             "turbulentIntensityKineticEnergyInletFvPatchScalarField"
  76             "(const fvPatch& p, const DimensionedField<scalar, volMesh>& iF, "
  77             "const dictionary& dict)"
  78         )   << "Turbulence intensity should be specified as a fraction 0-1 "
  79                "of the mean velocity\n"
  80                "    value given is " << intensity_
  81             << "\n    on patch " << this->patch().name()
  82             << " of field " << this->dimensionedInternalField().name()
  83             << " in file " << this->dimensionedInternalField().objectPath()
  84             << exit(FatalError);
  85     }
  86 }
  87
  88 Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::
  89 turbulentIntensityKineticEnergyInletFvPatchScalarField
  90 (
  91     const turbulentIntensityKineticEnergyInletFvPatchScalarField& ptf
  92 )
  93 :
  94     fixedValueFvPatchField<scalar>(ptf),
  95     intensity_(ptf.intensity_)
  96 {}
  97
  98
  99 Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::
 100 turbulentIntensityKineticEnergyInletFvPatchScalarField
 101 (
 102     const turbulentIntensityKineticEnergyInletFvPatchScalarField& ptf,
 103     const DimensionedField<scalar, volMesh>& iF
 104 )
 105 :
 106     fixedValueFvPatchField<scalar>(ptf, iF),
 107     intensity_(ptf.intensity_)
 108 {}
 109
 110
 111 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 112
 113 void Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::
 114 updateCoeffs()
 115 {
 116     if (updated())
 117     {
 118         return;
 119     }
 120
 121     const fvPatchField<vector>& Up =
 122         patch().lookupPatchField<volVectorField, vector>("U");
 123
 124     operator==(1.5*sqr(intensity_)*magSqr(Up));
 125
 126     fixedValueFvPatchField<scalar>::updateCoeffs();
 127 }
 128
 129
 130 void Foam::turbulentIntensityKineticEnergyInletFvPatchScalarField::write
 131 (
 132     Ostream& os
 133 ) const
 134 {
 135     fvPatchField<scalar>::write(os);
 136     os.writeKeyword("intensity") << intensity_ << token::END_STATEMENT << nl;
 137     writeEntry("value", os);
 138 }
 139
 140
 141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 142
 143 namespace Foam
 144 {
 145     makePatchTypeField
 146     (
 147         fvPatchScalarField,
 148         turbulentIntensityKineticEnergyInletFvPatchScalarField
 149     );
 150 }
 151
 152 // ************************************************************************* //