turbulentKineticEnergyFvPatchScalarField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2026 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM 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.
 
    OpenFOAM 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 OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::turbulentKineticEnergyFvPatchScalarField
 
Description
    This boundary condition provides a turbulent kinetic energy condition,
    based on user-supplied turbulence intensity, defined as a fraction of the
    mean velocity:
 
        \f[
            k_p = 1.5 (I |U|)^2
        \f]
 
    where
 
    \vartable
        k_p     | kinetic energy at the patch
        I       | turbulence intensity
        U       | velocity field
    \endvartable
 
    In the event of reverse flow, a zero-gradient condition is applied.
 
Usage
    \table
        Property     | Description             | Required    | Default value
        intensity    | fraction of mean field [0-1] | yes    |
        U            | velocity field name     | no          | U
        phi          | flux field name         | no          | phi
    \endtable
 
    Example of the boundary condition specification:
    \verbatim
    <patchName>
    {
        type        turbulentKineticEnergy;
        intensity   0.05;           // 5% turbulence
        value       uniform 1;      // placeholder
    }
    \endverbatim
 
See also
    Foam::inletOutletFvPatchField
 
SourceFiles
    turbulentKineticEnergyFvPatchScalarField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef turbulentKineticEnergyFvPatchScalarField_H
#define turbulentKineticEnergyFvPatchScalarField_H
 
#include "inletOutletFvPatchFields.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
   Class turbulentKineticEnergyFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
 
class turbulentKineticEnergyFvPatchScalarField
:
    public inletOutletFvPatchScalarField
{
    // Private Data
 
        //- Turbulent intensity as fraction of mean velocity
        scalar intensity_;
 
        //- Name of the velocity field
        word UName_;
 
 
public:
 
    //- Runtime type information
    TypeName("turbulentKineticEnergy");
 
 
    // Constructors
 
        //- Construct from patch, internal field and dictionary
        turbulentKineticEnergyFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar, fvMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given
        //  turbulentKineticEnergyFvPatchScalarField
        //  onto a new patch
        turbulentKineticEnergyFvPatchScalarField
        (
            const turbulentKineticEnergyFvPatchScalarField&,
            const fvPatch&,
            const DimensionedField<scalar, fvMesh>&,
            const fieldMapper&
        );
 
        //- Disallow copy without setting internal field reference
        turbulentKineticEnergyFvPatchScalarField
        (
            const turbulentKineticEnergyFvPatchScalarField&
        ) = delete;
 
        //- Copy constructor setting internal field reference
        turbulentKineticEnergyFvPatchScalarField
        (
            const turbulentKineticEnergyFvPatchScalarField&,
            const DimensionedField<scalar, fvMesh>&
        );
 
        //- Construct and return a clone setting internal field reference
        virtual tmp<fvPatchScalarField> clone
        (
            const DimensionedField<scalar, fvMesh>& iF
        ) const
        {
            return tmp<fvPatchScalarField>
            (
                new turbulentKineticEnergyFvPatchScalarField
                (
                    *this,
                    iF
                )
            );
        }
 
 
    // Member Functions
 
        //- Update the coefficients associated with the patch field
        virtual void updateCoeffs();
 
        //- Write
        virtual void write(Ostream&) const;
 
 
    // Member Operators
 
        //- Inherit assignment
        using inletOutletFvPatchScalarField::operator=;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //