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:

[legend]

Collaboration diagram for alphatFilmWallFunctionFvPatchScalarField:

[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< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	alphatFilmWallFunctionFvPatchScalarField (const alphatFilmWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (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
word	filmRegionName_
	Name of film region. More...

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.

Patch 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:

    myPatch
    {
        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 116 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::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 84 of file alphatFilmWallFunctionFvPatchScalarField.C.

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

◆ alphatFilmWallFunctionFvPatchScalarField() [4/5]

alphatFilmWallFunctionFvPatchScalarField ( const alphatFilmWallFunctionFvPatchScalarField & fwfpsf )

Construct as copy.

Definition at line 105 of file alphatFilmWallFunctionFvPatchScalarField.C.

◆ alphatFilmWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 121 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 184 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 201 of file alphatFilmWallFunctionFvPatchScalarField.H.

References alphatFilmWallFunctionFvPatchScalarField::alphatFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 138 of file alphatFilmWallFunctionFvPatchScalarField.C.

References ThermalDiffusivity< BasicTurbulenceModel >::alpha(), alphaEff, alphat, alphatFilmWallFunctionFvPatchScalarField::Cmu_, dimensionedInternalField(), Foam::exp(), alphatFilmWallFunctionFvPatchScalarField::filmRegionName_, forAll, Foam::constant::atomic::group, IOobject::groupName(), k, alphatFilmWallFunctionFvPatchScalarField::kappa_, Foam::max(), Foam::min(), UPstream::msgType(), patchi, Foam::pow(), Pr(), turbulenceModel::propertiesName, alphatFilmWallFunctionFvPatchScalarField::Prt_, Foam::sqrt(), uTau, y, and alphatFilmWallFunctionFvPatchScalarField::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 alphatFilmWallFunctionFvPatchScalarField::B_, alphatFilmWallFunctionFvPatchScalarField::Cmu_, token::END_STATEMENT, alphatFilmWallFunctionFvPatchScalarField::filmRegionName_, alphatFilmWallFunctionFvPatchScalarField::kappa_, Foam::nl, alphatFilmWallFunctionFvPatchScalarField::Prt_, fvPatchField::write(), Ostream::writeKeyword(), and alphatFilmWallFunctionFvPatchScalarField::yPlusCrit_.

Here is the call graph for this function:

Field Documentation

◆ filmRegionName_

word filmRegionName_

protected

Name of film region.

Definition at line 125 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ B_

scalar B_

protected

B Coefficient (default = 5.5)

Definition at line 128 of file alphatFilmWallFunctionFvPatchScalarField.H.

Referenced by alphatFilmWallFunctionFvPatchScalarField::write().

◆ yPlusCrit_

scalar yPlusCrit_

protected

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

Definition at line 131 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ Cmu_

scalar Cmu_

protected

Turbulent Cmu coefficient (default = 0.09)

Definition at line 134 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ kappa_

scalar kappa_

protected

Von-Karman constant (default = 0.41)

Definition at line 137 of file alphatFilmWallFunctionFvPatchScalarField.H.

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

◆ Prt_

scalar Prt_

protected

Turbulent Prandtl number (default = 0.85)

Definition at line 140 of file alphatFilmWallFunctionFvPatchScalarField.H.

Referenced by alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), and alphatFilmWallFunctionFvPatchScalarField::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()

Field Documentation

◆ filmRegionName_

◆ B_

◆ yPlusCrit_

◆ Cmu_

◆ kappa_

◆ Prt_