Public Member Functions | Protected Attributes | List of all members
alphatFilmWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a turbulent thermal diffusivity condition when using wall functions, for use with surface film models. This condition varies from the standard wall function by taking into account any mass released from the film model. More...

Inheritance diagram for alphatFilmWallFunctionFvPatchScalarField:
Inheritance graph
[legend]
Collaboration diagram for alphatFilmWallFunctionFvPatchScalarField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("alphatFilmWallFunction")
 Runtime type information. More...
 
 alphatFilmWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 alphatFilmWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 alphatFilmWallFunctionFvPatchScalarField (const alphatFilmWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 alphatFilmWallFunctionFvPatchScalarField (const alphatFilmWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 alphatFilmWallFunctionFvPatchScalarField (const alphatFilmWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Protected Attributes

scalar B_
 B Coefficient (default = 5.5) More...
 
scalar yPlusCrit_
 y+ value for laminar -> turbulent transition (default = 11.05) More...
 
scalar Cmu_
 Turbulent Cmu coefficient (default = 0.09) More...
 
scalar kappa_
 Von-Karman constant (default = 0.41) More...
 
scalar Prt_
 Turbulent Prandtl number (default = 0.85) More...
 

Detailed Description

This boundary condition provides a turbulent thermal diffusivity condition when using wall functions, for use with surface film models. This condition varies from the standard wall function by taking into account any mass released from the film model.

Usage
Property Description Required Default value
B model coefficient no 5.5
yPlusCrit critical y+ for transition to turbulent flow no 11.05
Cmu model coefficient no 0.09
kappa Von-Karman constant no 0.41
Prt turbulent Prandtl number no 0.85

Example of the boundary condition specification:

    <patchName>
    {
        type            alphatFilmWallFunction;
        B               5.5;
        yPlusCrit       11.05;
        Cmu             0.09;
        kappa           0.41;
        Prt             0.85;
        value           uniform 0;
    }
See also
Foam::fixedValueFvPatchField
Source files

Definition at line 112 of file alphatFilmWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ alphatFilmWallFunctionFvPatchScalarField() [1/5]

alphatFilmWallFunctionFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 48 of file alphatFilmWallFunctionFvPatchScalarField.C.

Referenced by alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField(), and alphatFilmWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ alphatFilmWallFunctionFvPatchScalarField() [2/5]

alphatFilmWallFunctionFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 82 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ alphatFilmWallFunctionFvPatchScalarField() [3/5]

Construct by mapping given.

alphatFilmWallFunctionFvPatchScalarField onto a new patch

Definition at line 64 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ alphatFilmWallFunctionFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 99 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ alphatFilmWallFunctionFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 114 of file alphatFilmWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "alphatFilmWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 177 of file alphatFilmWallFunctionFvPatchScalarField.H.

References alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 194 of file alphatFilmWallFunctionFvPatchScalarField.H.

References alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), and alphatFilmWallFunctionFvPatchScalarField::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

◆ write()

void write ( Ostream os) const
virtual

Member Data Documentation

◆ B_

scalar B_
protected

B Coefficient (default = 5.5)

Definition at line 121 of file alphatFilmWallFunctionFvPatchScalarField.H.

Referenced by alphatFilmWallFunctionFvPatchScalarField::write().

◆ yPlusCrit_

scalar yPlusCrit_
protected

y+ value for laminar -> turbulent transition (default = 11.05)

Definition at line 124 of file alphatFilmWallFunctionFvPatchScalarField.H.

Referenced by alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), and alphatFilmWallFunctionFvPatchScalarField::write().

◆ Cmu_

scalar Cmu_
protected

◆ kappa_

scalar kappa_
protected

◆ Prt_

scalar Prt_
protected

The documentation for this class was generated from the following files: