src/immersedBoundary/immersedBoundaryTurbulence/wallFunctions/immersedBoundaryOmegaWallFunctions/immersedBoundaryOmegaWallFunctionFvPatchScalarField.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::incompressible::RASModels::
  26     immersedBoundaryOmegaWallFunctionFvPatchScalarField
  27
  28 Description
  29     Provides a wall function boundary condition/constraint on omega
  30
  31     Computed value is:
  32
  33         omega = sqrt(omega_vis^2 + omega_log^2)
  34
  35     where
  36         omega_vis = omega in viscous region
  37         omega_log = omega in logarithmic region
  38
  39     Model described by Eq.(15) of:
  40     @verbatim
  41         Menter, F., Esch, T.
  42         "Elements of Industrial Heat Transfer Prediction"
  43         16th Brazilian Congress of Mechanical Engineering (COBEM),
  44         Nov. 2001
  45     @endverbatim
  46
  47 SourceFiles
  48     immersedBoundaryOmegaWallFunctionFvPatchScalarField.C
  49
  50 \*---------------------------------------------------------------------------*/
  51
  52 #ifndef immersedBoundaryOmegaWallFunctionFvPatchScalarField_H
  53 #define immersedBoundaryOmegaWallFunctionFvPatchScalarField_H
  54
  55 #include "immersedBoundaryWallFunctionFvPatchFields.H"
  56
  57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  58
  59 namespace Foam
  60 {
  61 namespace incompressible
  62 {
  63 namespace RASModels
  64 {
  65
  66 /*---------------------------------------------------------------------------*\
  67      Class immersedBoundaryOmegaWallFunctionFvPatchScalarField Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class immersedBoundaryOmegaWallFunctionFvPatchScalarField
  71 :
  72     public immersedBoundaryWallFunctionFvPatchScalarField
  73 {
  74     // Private data
  75
  76         //- Name of velocity field
  77         word UName_;
  78
  79         //- Name of turbulence kinetic energy field
  80         word kName_;
  81
  82         //- Name of turbulence generation field
  83         word GName_;
  84
  85         //- Name of laminar viscosity field
  86         word nuName_;
  87
  88         //- Name of turbulent viscosity field
  89         word nutName_;
  90
  91         //- Cmu coefficient
  92         scalar Cmu_;
  93
  94         //- Von Karman constant
  95         scalar kappa_;
  96
  97         //- E coefficient
  98         scalar E_;
  99
 100         //- beta1 coefficient
 101         scalar beta1_;
 102
 103
 104 public:
 105
 106     //- Runtime type information
 107     TypeName("immersedBoundaryOmegaWallFunction");
 108
 109
 110     // Constructors
 111
 112         //- Construct from patch and internal field
 113         immersedBoundaryOmegaWallFunctionFvPatchScalarField
 114         (
 115             const fvPatch&,
 116             const DimensionedField<scalar, volMesh>&
 117         );
 118
 119         //- Construct from patch, internal field and dictionary
 120         immersedBoundaryOmegaWallFunctionFvPatchScalarField
 121         (
 122             const fvPatch&,
 123             const DimensionedField<scalar, volMesh>&,
 124             const dictionary&
 125         );
 126
 127         //- Construct by mapping given
 128         //  immersedBoundaryOmegaWallFunctionFvPatchScalarField
 129         //  onto a new patch
 130         immersedBoundaryOmegaWallFunctionFvPatchScalarField
 131         (
 132             const immersedBoundaryOmegaWallFunctionFvPatchScalarField&,
 133             const fvPatch&,
 134             const DimensionedField<scalar, volMesh>&,
 135             const fvPatchFieldMapper&
 136         );
 137
 138         //- Construct as copy
 139         immersedBoundaryOmegaWallFunctionFvPatchScalarField
 140         (
 141             const immersedBoundaryOmegaWallFunctionFvPatchScalarField&
 142         );
 143
 144         //- Construct and return a clone
 145         virtual tmp<fvPatchScalarField> clone() const
 146         {
 147             return tmp<fvPatchScalarField>
 148             (
 149                 new immersedBoundaryOmegaWallFunctionFvPatchScalarField
 150                 (
 151                     *this
 152                 )
 153             );
 154         }
 155
 156         //- Construct as copy setting internal field reference
 157         immersedBoundaryOmegaWallFunctionFvPatchScalarField
 158         (
 159             const immersedBoundaryOmegaWallFunctionFvPatchScalarField&,
 160             const DimensionedField<scalar, volMesh>&
 161         );
 162
 163         //- Construct and return a clone setting internal field reference
 164         virtual tmp<fvPatchScalarField> clone
 165         (
 166             const DimensionedField<scalar, volMesh>& iF
 167         ) const
 168         {
 169             return tmp<fvPatchScalarField>
 170             (
 171                 new immersedBoundaryOmegaWallFunctionFvPatchScalarField
 172                 (
 173                     *this,
 174                     iF
 175                 )
 176             );
 177         }
 178
 179
 180     //- Destructor
 181     virtual ~immersedBoundaryOmegaWallFunctionFvPatchScalarField()
 182     {}
 183
 184
 185     // Member functions
 186
 187         // Evaluation functions
 188
 189             //- Update the coefficients associated with the patch field
 190             virtual void updateCoeffs();
 191
 192             //- Evaluate the patchField
 193             virtual void evaluate
 194             (
 195                 const Pstream::commsTypes  = Pstream::blocking
 196             );
 197
 198
 199         // I-O
 200
 201             //- Write
 202             void write(Ostream&) const;
 203 };
 204
 205
 206 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 207
 208 } // End namespace RASModels
 209 } // End namespace incompressible
 210 } // End namespace Foam
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 #endif
 215
 216 // ************************************************************************* //