src/finiteVolume/fields/fvPatchFields/derived/fluxCorrectedVelocity/fluxCorrectedVelocityFvPatchVectorField.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 "fluxCorrectedVelocityFvPatchVectorField.H"
  28 #include "addToRunTimeSelectionTable.H"
  29 #include "fvPatchFieldMapper.H"
  30 #include "volFields.H"
  31 #include "surfaceFields.H"
  32
  33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  34
  35 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  36
  37 Foam::fluxCorrectedVelocityFvPatchVectorField::
  38 fluxCorrectedVelocityFvPatchVectorField
  39 (
  40     const fvPatch& p,
  41     const DimensionedField<vector, volMesh>& iF
  42 )
  43 :
  44     zeroGradientFvPatchVectorField(p, iF),
  45     phiName_("phi"),
  46     rhoName_("rho")
  47 {}
  48
  49
  50 Foam::fluxCorrectedVelocityFvPatchVectorField::
  51 fluxCorrectedVelocityFvPatchVectorField
  52 (
  53     const fluxCorrectedVelocityFvPatchVectorField& ptf,
  54     const fvPatch& p,
  55     const DimensionedField<vector, volMesh>& iF,
  56     const fvPatchFieldMapper& mapper
  57 )
  58 :
  59     zeroGradientFvPatchVectorField(ptf, p, iF, mapper),
  60     phiName_(ptf.phiName_),
  61     rhoName_(ptf.rhoName_)
  62 {}
  63
  64
  65 Foam::fluxCorrectedVelocityFvPatchVectorField::
  66 fluxCorrectedVelocityFvPatchVectorField
  67 (
  68     const fvPatch& p,
  69     const DimensionedField<vector, volMesh>& iF,
  70     const dictionary& dict
  71 )
  72 :
  73     zeroGradientFvPatchVectorField(p, iF),
  74     phiName_(dict.lookupOrDefault<word>("phi", "phi")),
  75     rhoName_(dict.lookupOrDefault<word>("rho", "rho"))
  76 {
  77     fvPatchVectorField::operator=(patchInternalField());
  78 }
  79
  80
  81 Foam::fluxCorrectedVelocityFvPatchVectorField::
  82 fluxCorrectedVelocityFvPatchVectorField
  83 (
  84     const fluxCorrectedVelocityFvPatchVectorField& fcvpvf,
  85     const DimensionedField<vector, volMesh>& iF
  86 )
  87 :
  88     zeroGradientFvPatchVectorField(fcvpvf, iF),
  89     phiName_(fcvpvf.phiName_),
  90     rhoName_(fcvpvf.rhoName_)
  91 {}
  92
  93
  94 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  95
  96 void Foam::fluxCorrectedVelocityFvPatchVectorField::evaluate
  97 (
  98     const Pstream::commsTypes
  99 )
 100 {
 101     if (!updated())
 102     {
 103         updateCoeffs();
 104     }
 105
 106     zeroGradientFvPatchVectorField::evaluate();
 107
 108     const surfaceScalarField& phi =
 109         db().lookupObject<surfaceScalarField>(phiName_);
 110
 111     const fvsPatchField<scalar>& phip =
 112         patch().patchField<surfaceScalarField, scalar>(phi);
 113
 114     vectorField n = patch().nf();
 115     const Field<scalar>& magS = patch().magSf();
 116
 117     if (phi.dimensions() == dimVelocity*dimArea)
 118     {
 119         operator==(*this - n*(n & *this) + n*phip/magS);
 120     }
 121     else if (phi.dimensions() == dimDensity*dimVelocity*dimArea)
 122     {
 123         const fvPatchField<scalar>& rhop =
 124             patch().lookupPatchField<volScalarField, scalar>(rhoName_);
 125
 126         operator==(*this - n*(n & *this) + n*phip/(rhop*magS));
 127     }
 128     else
 129     {
 130         FatalErrorIn
 131         (
 132             "fluxCorrectedVelocityFvPatchVectorField::evaluate()"
 133         )
 134             << "dimensions of phi are incorrect\n"
 135             << "    on patch " << this->patch().name()
 136             << " of field " << this->dimensionedInternalField().name()
 137             << " in file " << this->dimensionedInternalField().objectPath()
 138             << exit(FatalError);
 139     }
 140 }
 141
 142
 143 void Foam::fluxCorrectedVelocityFvPatchVectorField::write(Ostream& os) const
 144 {
 145     fvPatchVectorField::write(os);
 146     if (phiName_ != "phi")
 147     {
 148         os.writeKeyword("phi") << phiName_ << token::END_STATEMENT << nl;
 149     }
 150     if (rhoName_ != "rho")
 151     {
 152         os.writeKeyword("rho") << rhoName_ << token::END_STATEMENT << nl;
 153     }
 154     writeEntry("value", os);
 155 }
 156
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 namespace Foam
 161 {
 162     makePatchTypeField
 163     (
 164         fvPatchVectorField,
 165         fluxCorrectedVelocityFvPatchVectorField
 166     );
 167 }
 168
 169 // ************************************************************************* //