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...

#include <alphatFilmWallFunctionFvPatchScalarField.H>

Inheritance diagram for alphatFilmWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for alphatFilmWallFunctionFvPatchScalarField:

[legend]

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

Protected Attributes
word	filmRegionName_
	Name of film region.
scalar	B_
	B Coefficient.
scalar	yPlusCrit_
	y+ value for laminar -> turbulent transition
scalar	Cmu_
	Empirical model coefficient.
scalar	kappa_
	Von-Karman constant.
scalar	Prt_
	Turbulent Prandtl number.

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

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            alphatFilmWallFunction;

    // Optional entries
    filmRegion      <word>;
    B               <scalar>;
    yPlusCrit       <scalar>;
    Cmu             <scalar>;
    kappa           <scalar>;
    Prt             <scalar>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: alphatFilmWallFunction	word	yes	-
`filmRegion`	Name of film region	word	no	surfaceFilmProperties
`B`	Model coefficient	scalar	no	5.5
`yPlusCrit`	Critical y+ for transition to turbulence	scalar	no	11.5
`Cmu`	Empirical model coefficient	scalar	no	0.09
`Prt`	Turbulent Prandtl number	scalar	no	0.85
`kappa`	von Karman constant	scalar	no	0.41

The inherited entries are elaborated in:

fixedValueFvPatchFields.H

Source files

Definition at line 141 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 42 of file alphatFilmWallFunctionFvPatchScalarField.C.

References B_, Cmu_, filmRegionName_, kappa_, p, Prt_, and yPlusCrit_.

Referenced by alphatFilmWallFunctionFvPatchScalarField(), alphatFilmWallFunctionFvPatchScalarField(), alphatFilmWallFunctionFvPatchScalarField(), and TypeName().

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 78 of file alphatFilmWallFunctionFvPatchScalarField.C.

References B_, Cmu_, dict, filmRegionName_, kappa_, p, Prt_, and yPlusCrit_.

◆ alphatFilmWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given alphatFilmWallFunctionFvPatchScalarField onto a new patch.

Definition at line 59 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphatFilmWallFunctionFvPatchScalarField(), B_, Cmu_, filmRegionName_, kappa_, p, Prt_, and yPlusCrit_.

Here is the call graph for this function:

◆ alphatFilmWallFunctionFvPatchScalarField() [4/5]

alphatFilmWallFunctionFvPatchScalarField ( const alphatFilmWallFunctionFvPatchScalarField & fwfpsf )

Construct as copy.

Definition at line 99 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphatFilmWallFunctionFvPatchScalarField(), B_, Cmu_, filmRegionName_, kappa_, Prt_, and yPlusCrit_.

Here is the call graph for this function:

◆ alphatFilmWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 115 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphatFilmWallFunctionFvPatchScalarField(), B_, Cmu_, filmRegionName_, kappa_, Prt_, and yPlusCrit_.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "alphatFilmWallFunction" )

Runtime type information.

References alphatFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 242 of file alphatFilmWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 250 of file alphatFilmWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 134 of file alphatFilmWallFunctionFvPatchScalarField.C.

References alphaEff(), Cmu_, Foam::exp(), filmRegionName_, forAll, IOobject::groupName(), UPstream::incrMsgType(), k, kappa_, Foam::max(), Foam::min(), UPstream::msgType(), Foam::pow(), Foam::pow025(), Pr(), turbulenceModel::propertiesName, Prt_, Foam::sqrt(), uTau, y, yPlus, and yPlusCrit_.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 237 of file alphatFilmWallFunctionFvPatchScalarField.C.

References B_, Cmu_, filmRegionName_, kappa_, os(), Prt_, fvPatchField< Type >::write(), fvPatchField< Type >::writeValueEntry(), and yPlusCrit_.

Here is the call graph for this function:

Member Data Documentation

◆ filmRegionName_

word filmRegionName_

protected

Name of film region.

Definition at line 152 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ B_

scalar B_

protected

B Coefficient.

Definition at line 157 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ yPlusCrit_

scalar yPlusCrit_

protected

y+ value for laminar -> turbulent transition

Definition at line 162 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ Cmu_

scalar Cmu_

protected

Empirical model coefficient.

Definition at line 167 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ kappa_

scalar kappa_

protected

Von-Karman constant.

Definition at line 172 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ Prt_

scalar Prt_

protected

Turbulent Prandtl number.

Definition at line 177 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

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

src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.H
src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/alphatFilmWallFunction/alphatFilmWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ alphatFilmWallFunctionFvPatchScalarField() [1/5]

◆ alphatFilmWallFunctionFvPatchScalarField() [2/5]

◆ alphatFilmWallFunctionFvPatchScalarField() [3/5]

◆ alphatFilmWallFunctionFvPatchScalarField() [4/5]

◆ alphatFilmWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ filmRegionName_

◆ B_

◆ yPlusCrit_

◆ Cmu_

◆ kappa_

◆ Prt_