src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.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::nutLowReWallFunctionFvPatchScalarField
  26
  27 Description
  28     Boundary condition for turbulent (kinematic) viscosity when for use with
  29     low Reynolds number models.
  30
  31     Sets nut to zero, and provides an access function to calculate y+.
  32
  33 SourceFiles
  34     nutLowReWallFunctionFvPatchScalarField.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef nutLowReWallFunctionFvPatchScalarField_H
  39 #define nutLowReWallFunctionFvPatchScalarField_H
  40
  41 #include "nutkWallFunctionFvPatchScalarField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace incompressible
  48 {
  49 namespace RASModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53            Class nutLowReWallFunctionFvPatchScalarField Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class nutLowReWallFunctionFvPatchScalarField
  57 :
  58     public nutkWallFunctionFvPatchScalarField
  59 {
  60 protected:
  61
  62     // Protected Member Functions
  63
  64         //- Calculate the turbulence viscosity
  65         virtual tmp<scalarField> calcNut() const;
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("nutLowReWallFunction");
  72
  73
  74     // Constructors
  75
  76         //- Construct from patch and internal field
  77         nutLowReWallFunctionFvPatchScalarField
  78         (
  79             const fvPatch&,
  80             const DimensionedField<scalar, volMesh>&
  81         );
  82
  83         //- Construct from patch, internal field and dictionary
  84         nutLowReWallFunctionFvPatchScalarField
  85         (
  86             const fvPatch&,
  87             const DimensionedField<scalar, volMesh>&,
  88             const dictionary&
  89         );
  90
  91         //- Construct by mapping given
  92         //  nutLowReWallFunctionFvPatchScalarField
  93         //  onto a new patch
  94         nutLowReWallFunctionFvPatchScalarField
  95         (
  96             const nutLowReWallFunctionFvPatchScalarField&,
  97             const fvPatch&,
  98             const DimensionedField<scalar, volMesh>&,
  99             const fvPatchFieldMapper&
 100         );
 101
 102         //- Construct as copy
 103         nutLowReWallFunctionFvPatchScalarField
 104         (
 105             const nutLowReWallFunctionFvPatchScalarField&
 106         );
 107
 108         //- Construct and return a clone
 109         virtual tmp<fvPatchScalarField> clone() const
 110         {
 111             return tmp<fvPatchScalarField>
 112             (
 113                 new nutLowReWallFunctionFvPatchScalarField(*this)
 114             );
 115         }
 116
 117         //- Construct as copy setting internal field reference
 118         nutLowReWallFunctionFvPatchScalarField
 119         (
 120             const nutLowReWallFunctionFvPatchScalarField&,
 121             const DimensionedField<scalar, volMesh>&
 122         );
 123
 124         //- Construct and return a clone setting internal field reference
 125         virtual tmp<fvPatchScalarField> clone
 126         (
 127             const DimensionedField<scalar, volMesh>& iF
 128         ) const
 129         {
 130             return tmp<fvPatchScalarField>
 131             (
 132                 new nutLowReWallFunctionFvPatchScalarField(*this, iF)
 133             );
 134         }
 135 };
 136
 137
 138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 139
 140 } // End namespace RASModels
 141 } // End namespace incompressible
 142 } // End namespace Foam
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #endif
 147
 148 // ************************************************************************* //