src/finiteVolume/fields/fvPatchFields/derived/parabolicVelocity/parabolicVelocityFvPatchVectorField.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 "parabolicVelocityFvPatchVectorField.H"
  28 #include "addToRunTimeSelectionTable.H"
  29 #include "fvPatchFieldMapper.H"
  30 #include "volFields.H"
  31 #include "surfaceFields.H"
  32
  33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  34
  35 namespace Foam
  36 {
  37
  38 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  39
  40 parabolicVelocityFvPatchVectorField::parabolicVelocityFvPatchVectorField
  41 (
  42     const fvPatch& p,
  43     const DimensionedField<vector, volMesh>& iF
  44 )
  45 :
  46     fixedValueFvPatchVectorField(p, iF),
  47     maxValue_(0),
  48     n_(1, 0, 0),
  49     y_(0, 1, 0)
  50 {}
  51
  52
  53 parabolicVelocityFvPatchVectorField::parabolicVelocityFvPatchVectorField
  54 (
  55     const parabolicVelocityFvPatchVectorField& ptf,
  56     const fvPatch& p,
  57     const DimensionedField<vector, volMesh>& iF,
  58     const fvPatchFieldMapper& mapper
  59 )
  60 :
  61     fixedValueFvPatchVectorField(ptf, p, iF, mapper),
  62     maxValue_(ptf.maxValue_),
  63     n_(ptf.n_),
  64     y_(ptf.y_)
  65 {}
  66
  67
  68 parabolicVelocityFvPatchVectorField::parabolicVelocityFvPatchVectorField
  69 (
  70     const fvPatch& p,
  71     const DimensionedField<vector, volMesh>& iF,
  72     const dictionary& dict
  73 )
  74 :
  75     fixedValueFvPatchVectorField(p, iF),
  76     maxValue_(readScalar(dict.lookup("maxValue"))),
  77     n_(dict.lookup("n")),
  78     y_(dict.lookup("y"))
  79 {
  80     if (mag(n_) < SMALL || mag(y_) < SMALL)
  81     {
  82         FatalErrorIn("parabolicVelocityFvPatchVectorField(dict)")
  83             << "n or y given with zero size not correct"
  84             << abort(FatalError);
  85     }
  86
  87     n_ /= mag(n_);
  88     y_ /= mag(y_);
  89
  90     evaluate();
  91 }
  92
  93
  94 parabolicVelocityFvPatchVectorField::parabolicVelocityFvPatchVectorField
  95 (
  96     const parabolicVelocityFvPatchVectorField& fcvpvf,
  97     const DimensionedField<vector, volMesh>& iF
  98 )
  99 :
 100     fixedValueFvPatchVectorField(fcvpvf, iF),
 101     maxValue_(fcvpvf.maxValue_),
 102     n_(fcvpvf.n_),
 103     y_(fcvpvf.y_)
 104 {}
 105
 106
 107 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 108
 109 void parabolicVelocityFvPatchVectorField::updateCoeffs()
 110 {
 111     if (updated())
 112     {
 113         return;
 114     }
 115
 116     // Get range and orientation
 117     boundBox bb(patch().patch().localPoints(), true);
 118
 119     vector ctr = 0.5*(bb.max() + bb.min());
 120
 121     const vectorField& c = patch().Cf();
 122
 123     // Calculate local 1-D coordinate for the parabolic profile
 124     scalarField coord = 2*((c - ctr) & y_)/((bb.max() - bb.min()) & y_);
 125
 126     vectorField::operator=(n_*maxValue_*(1.0 - sqr(coord)));
 127 }
 128
 129
 130 // Write
 131 void parabolicVelocityFvPatchVectorField::write(Ostream& os) const
 132 {
 133     fvPatchVectorField::write(os);
 134     os.writeKeyword("maxValue")
 135         << maxValue_ << token::END_STATEMENT << nl;
 136     os.writeKeyword("n")
 137         << n_ << token::END_STATEMENT << nl;
 138     os.writeKeyword("y")
 139         << y_ << token::END_STATEMENT << nl;
 140     writeEntry("value", os);
 141 }
 142
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 makePatchTypeField(fvPatchVectorField, parabolicVelocityFvPatchVectorField);
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 } // End namespace Foam
 151
 152 // ************************************************************************* //