src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/omegaWallFunctions/omegaWallFunction/omegaWallFunctionFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::incompressible::RASModels::omegaWallFunctionFvPatchScalarField
  26
  27 Description
  28     Provides a wall function boundary condition/constraint on omega
  29
  30     Computed value is:
  31
  32         omega = sqrt(omega_vis^2 + omega_log^2)
  33
  34     where
  35         omega_vis = omega in viscous region
  36         omega_log = omega in logarithmic region
  37
  38     Model described by Eq.(15) of:
  39     \verbatim
  40         Menter, F., Esch, T.
  41         "Elements of Industrial Heat Transfer Prediction"
  42         16th Brazilian Congress of Mechanical Engineering (COBEM),
  43         Nov. 2001
  44     \endverbatim
  45
  46 SourceFiles
  47     omegaWallFunctionFvPatchScalarField.C
  48
  49 \*---------------------------------------------------------------------------*/
  50
  51 #ifndef omegaWallFunctionFvPatchScalarField_H
  52 #define omegaWallFunctionFvPatchScalarField_H
  53
  54 #include "fixedInternalValueFvPatchField.H"
  55
  56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  57
  58 namespace Foam
  59 {
  60 namespace incompressible
  61 {
  62 namespace RASModels
  63 {
  64
  65 /*---------------------------------------------------------------------------*\
  66            Class omegaWallFunctionFvPatchScalarField Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 class omegaWallFunctionFvPatchScalarField
  70 :
  71     public fixedInternalValueFvPatchField<scalar>
  72 {
  73 protected:
  74
  75     // Protected data
  76
  77         //- Name of turbulence generation field
  78         word GName_;
  79
  80         //- Cmu coefficient
  81         scalar Cmu_;
  82
  83         //- Von Karman constant
  84         scalar kappa_;
  85
  86         //- E coefficient
  87         scalar E_;
  88
  89         //- beta1 coefficient
  90         scalar beta1_;
  91
  92         //- Y+ at the edge of the laminar sublayer
  93         scalar yPlusLam_;
  94
  95
  96     // Protected Member Functions
  97
  98         //- Check the type of the patch
  99         virtual void checkType();
 100
 101         //- Calculate the Y+ at the edge of the laminar sublayer
 102         virtual scalar calcYPlusLam(const scalar kappa, const scalar E) const;
 103
 104         //- Write local wall function variables
 105         virtual void writeLocalEntries(Ostream&) const;
 106
 107
 108 public:
 109
 110     //- Runtime type information
 111     TypeName("omegaWallFunction");
 112
 113
 114     // Constructors
 115
 116         //- Construct from patch and internal field
 117         omegaWallFunctionFvPatchScalarField
 118         (
 119             const fvPatch&,
 120             const DimensionedField<scalar, volMesh>&
 121         );
 122
 123         //- Construct from patch, internal field and dictionary
 124         omegaWallFunctionFvPatchScalarField
 125         (
 126             const fvPatch&,
 127             const DimensionedField<scalar, volMesh>&,
 128             const dictionary&
 129         );
 130
 131         //- Construct by mapping given
 132         // omegaWallFunctionFvPatchScalarField
 133         //  onto a new patch
 134         omegaWallFunctionFvPatchScalarField
 135         (
 136             const omegaWallFunctionFvPatchScalarField&,
 137             const fvPatch&,
 138             const DimensionedField<scalar, volMesh>&,
 139             const fvPatchFieldMapper&
 140         );
 141
 142         //- Construct as copy
 143         omegaWallFunctionFvPatchScalarField
 144         (
 145             const omegaWallFunctionFvPatchScalarField&
 146         );
 147
 148         //- Construct and return a clone
 149         virtual tmp<fvPatchScalarField> clone() const
 150         {
 151             return tmp<fvPatchScalarField>
 152             (
 153                 new omegaWallFunctionFvPatchScalarField(*this)
 154             );
 155         }
 156
 157         //- Construct as copy setting internal field reference
 158         omegaWallFunctionFvPatchScalarField
 159         (
 160             const omegaWallFunctionFvPatchScalarField&,
 161             const DimensionedField<scalar, volMesh>&
 162         );
 163
 164         //- Construct and return a clone setting internal field reference
 165         virtual tmp<fvPatchScalarField> clone
 166         (
 167             const DimensionedField<scalar, volMesh>& iF
 168         ) const
 169         {
 170             return tmp<fvPatchScalarField>
 171             (
 172                 new omegaWallFunctionFvPatchScalarField(*this, iF)
 173             );
 174         }
 175
 176
 177     // Member functions
 178
 179         // Evaluation functions
 180
 181             //- Update the coefficients associated with the patch field
 182             virtual void updateCoeffs();
 183
 184
 185         // I-O
 186
 187             //- Write
 188             virtual void write(Ostream&) const;
 189 };
 190
 191
 192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 193
 194 } // End namespace RASModels
 195 } // End namespace incompressible
 196 } // End namespace Foam
 197
 198 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 199
 200 #endif
 201
 202 // ************************************************************************* //