src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.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::nutUSpaldingWallFunctionFvPatchScalarField
  26
  27 Description
  28     Wall function boundary condition for walls, based on velocity, using
  29     Spaldings law to give a continuous nut profile to the wall (y+ = 0)
  30
  31 SourceFiles
  32     nutUSpaldingWallFunctionFvPatchScalarField.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef nutUSpaldingWallFunctionFvPatchScalarField_H
  37 #define nutUSpaldingWallFunctionFvPatchScalarField_H
  38
  39 #include "nutkWallFunctionFvPatchScalarField.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45 namespace incompressible
  46 {
  47 namespace RASModels
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51               Class nutUSpaldingWallFunctionFvPatch Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class nutUSpaldingWallFunctionFvPatchScalarField
  55 :
  56     public nutkWallFunctionFvPatchScalarField
  57 {
  58 protected:
  59
  60     // Protected Member Functions
  61
  62         //- Calculate the turbulence viscosity
  63         virtual tmp<scalarField> calcNut() const;
  64
  65         //- Calculate the friction velocity
  66         virtual tmp<scalarField> calcUTau(const scalarField& magGradU) const;
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("nutUSpaldingWallFunction");
  73
  74
  75     // Constructors
  76
  77         //- Construct from patch and internal field
  78         nutUSpaldingWallFunctionFvPatchScalarField
  79         (
  80             const fvPatch&,
  81             const DimensionedField<scalar, volMesh>&
  82         );
  83
  84         //- Construct from patch, internal field and dictionary
  85         nutUSpaldingWallFunctionFvPatchScalarField
  86         (
  87             const fvPatch&,
  88             const DimensionedField<scalar, volMesh>&,
  89             const dictionary&
  90         );
  91
  92         //- Construct by mapping given
  93         //  nutUSpaldingWallFunctionFvPatchScalarField
  94         //  onto a new patch
  95         nutUSpaldingWallFunctionFvPatchScalarField
  96         (
  97             const nutUSpaldingWallFunctionFvPatchScalarField&,
  98             const fvPatch&,
  99             const DimensionedField<scalar, volMesh>&,
 100             const fvPatchFieldMapper&
 101         );
 102
 103         //- Construct as copy
 104         nutUSpaldingWallFunctionFvPatchScalarField
 105         (
 106             const nutUSpaldingWallFunctionFvPatchScalarField&
 107         );
 108
 109         //- Construct and return a clone
 110         virtual tmp<fvPatchScalarField> clone() const
 111         {
 112             return tmp<fvPatchScalarField>
 113             (
 114                 new nutUSpaldingWallFunctionFvPatchScalarField(*this)
 115             );
 116         }
 117
 118         //- Construct as copy setting internal field reference
 119         nutUSpaldingWallFunctionFvPatchScalarField
 120         (
 121             const nutUSpaldingWallFunctionFvPatchScalarField&,
 122             const DimensionedField<scalar, volMesh>&
 123         );
 124
 125         //- Construct and return a clone setting internal field reference
 126         virtual tmp<fvPatchScalarField> clone
 127         (
 128             const DimensionedField<scalar, volMesh>& iF
 129         ) const
 130         {
 131             return tmp<fvPatchScalarField>
 132             (
 133                 new nutUSpaldingWallFunctionFvPatchScalarField(*this, iF)
 134             );
 135         }
 136
 137
 138     // Member functions
 139
 140         // Evaluation functions
 141
 142             //- Calculate and return the yPlus at the boundary
 143             virtual tmp<scalarField> yPlus() const;
 144
 145
 146         // I-O
 147
 148             //- Write
 149             virtual void write(Ostream& os) const;
 150 };
 151
 152
 153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 154
 155 } // End namespace RASModels
 156 } // End namespace incompressible
 157 } // End namespace Foam
 158
 159 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 160
 161 #endif
 162
 163 // ************************************************************************* //