.. _program_listing_file_wallModels_wallModelFvPatchScalarField.H:

Program Listing for File wallModelFvPatchScalarField.H
======================================================

|exhale_lsh| :ref:`Return to documentation for file <file_wallModels_wallModelFvPatchScalarField.H>` (``wallModels/wallModelFvPatchScalarField.H``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*---------------------------------------------------------------------------* \
   License
       This file is part of libWallModelledLES.
   
       libWallModelledLES is free software: you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or
       (at your option) any later version.
   
       libWallModelledLES is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
       or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       for more details.
   
       You should have received a copy of the GNU General Public License
       along with libWallModelledLES.
       If not, see <http://www.gnu.org/licenses/>.
   
   Class
       Foam::wallModelFvPatchScalarField
   
   @brief
       Base abstract class for LES wall models.
   
       Handles creating and storing fields used by the wall models.
       The following fields are created and stored in the registry.
       - hSampler or h, the patch fields of which hold the distance to the cells
       used for sampling. This field is read and must be present for the simulation
       to run.
       - uTauPredicted, the patch fields of which hold the value of uTau as
       predicted by the wall model.
       - wallShearStress, the patch fields of which hold the value of the wall
       shear stress.
       - wallGradU, the patch fields of which store the wall-normal velocity
       gradient.
   
   
   Contributors/Copyright:
       2018-2026 Timofey Mukha
   
   SourceFiles
       wallModelFvPatchScalarField.C
   
   \*---------------------------------------------------------------------------*/
   
   #ifndef wallModelFvPatchScalarField_H
   #define wallModelFvPatchScalarField_H
   
   #include "fixedValueFvPatchFields.H"
   #include "volFields.H"
   
   // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
   
   namespace Foam
   {
   
   /*---------------------------------------------------------------------------*\
                   Class wallModelFvPatchScalarField Declaration
   \*---------------------------------------------------------------------------*/
   
   class wallModelFvPatchScalarField
   :
       public fixedValueFvPatchScalarField
   {
   private:
   
       //- Fraction of CPU time spent on wall modelling
       scalar consumedTime_;
   
       //- Switch to copy data to wall-adjacent cells
       bool copyToPatchInternalField_;
   
       //- Whether to suppress most output to the log file
       bool silent_;
   protected:
   
       // Protected data
   
           //- Timescale of the averaging
           scalar averagingTime_;
   
           //- Create fields and add to registry
           virtual void createFields() const;
   
       // Protected Member Functions
   
           //- Check that the patch is a wall
           virtual void checkType();
   
           //- Return the laminar viscosity
           //  Note: this is the internal field
           tmp<volScalarField> nu() const;
   
           //- Return laminar viscosity on patchi
           tmp<scalarField> nu(const label patchi) const;
   
           //- Calculate the turbulence viscosity
           virtual tmp<scalarField> calcNut() const = 0;
   
           //- Write local wall function variables
           virtual void writeLocalEntries(Ostream&) const;
   
           //- Set the wallShearStress field
           void setShearStress(const volSymmTensorField &);
   
   
   public:
   
   #if !defined(DOXYGEN_SHOULD_SKIP_THIS)
       //- Runtime type information
       TypeName("wallModel");
   #endif
   
       // Constructors
   
           //- Construct from patch and internal field
           wallModelFvPatchScalarField
           (
               const fvPatch&,
               const DimensionedField<scalar, volMesh>&
           );
   
           //- Construct from patch, internal field and dictionary
           wallModelFvPatchScalarField
           (
               const fvPatch&,
               const DimensionedField<scalar, volMesh>&,
               const dictionary&
           );
   
           //- Construct by mapping given
           //  wallModelFvPatchScalarField
           //  onto a new patch
           wallModelFvPatchScalarField
           (
               const wallModelFvPatchScalarField&,
               const fvPatch&,
               const DimensionedField<scalar, volMesh>&,
               const fvPatchFieldMapper&
           );
   
           #ifdef FOAM_FVPATCHFIELD_NO_COPY
           #else
           //- Construct as copy
           wallModelFvPatchScalarField
           (
               const wallModelFvPatchScalarField&
           );
           #endif
   
           //- Construct as copy setting internal field reference
           wallModelFvPatchScalarField
           (
               const wallModelFvPatchScalarField&,
               const DimensionedField<scalar, volMesh>&
           );
   
   
       // Member functions
   
           scalar averagingTime() const
           {
               return averagingTime_;
           }
   
           scalar consumedTime() const
           {
               return consumedTime_;
           }
   
           bool silent() const
           {
               return silent_;
           }
   
           bool copyToPatchInternalField() const
           {
               return copyToPatchInternalField_;
           }
   
           //- Update the boundary values
           virtual void updateCoeffs();
   
           //- Write to stream
           virtual void write(Ostream&) const;
   };
   
   
   // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
   
   } // End namespace Foam
   
   // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
   
   #endif