nutkFilmWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a turbulent viscosity condition when using wall functions, based on turbulence kinetic energy, for use with surface film models. More...

Inheritance diagram for nutkFilmWallFunctionFvPatchScalarField:

Collaboration diagram for nutkFilmWallFunctionFvPatchScalarField:

Public Member Functions
	TypeName ("nutkFilmWallFunction")
	nutkFilmWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	nutkFilmWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	nutkFilmWallFunctionFvPatchScalarField (const nutkFilmWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	nutkFilmWallFunctionFvPatchScalarField (const nutkFilmWallFunctionFvPatchScalarField &)
virtual tmp< fvPatchScalarField >	clone () const
	nutkFilmWallFunctionFvPatchScalarField (const nutkFilmWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
virtual tmp< scalarField >	yPlus () const
virtual void	write (Ostream &os) const
Public Member Functions inherited from nutkWallFunctionFvPatchScalarField
	TypeName ("nutkWallFunction")
	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
scalar	Cmu () const
scalar	kappa () const
scalar	E () const
scalar	yPlusLam () const
scalar	blend (const scalar nutVis, const scalar nutLog, const scalar yPlus) const
virtual void	updateCoeffs ()

Protected Member Functions
virtual tmp< scalarField >	calcNut () const
virtual tmp< scalarField >	calcUTau (const scalarField &magGradU) const
Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const
virtual void	checkType ()
virtual void	writeLocalEntries (Ostream &) const

Protected Attributes
word	filmRegionName_
scalar	B_
scalar	yPlusCrit_
Protected Attributes inherited from nutWallFunctionFvPatchScalarField
enum blendingType	blending_
const scalar	n_
word	UName_
scalar	Cmu_
scalar	kappa_
scalar	E_
scalar	yPlusLam_

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarField &	nutw (const turbulenceModel &turbModel, const label patchi)
static scalar	yPlusLam (const scalar kappa, const scalar E)
Protected Types inherited from nutWallFunctionFvPatchScalarField
enum	blendingType { STEPWISE, MAX, BINOMIAL, EXPONENTIAL }
Static Protected Attributes inherited from nutWallFunctionFvPatchScalarField
static const Enum< blendingType >	blendingTypeNames

Detailed Description

This boundary condition provides a turbulent viscosity condition when using wall functions, based on turbulence kinetic energy, for use with surface film models.

Usage

Example of the boundary condition specification:

<patchName>
{
    type            nutkFilmWallFunction;
    value           uniform 0;
}

See also

Foam::nutkWallFunctionFvPatchScalarField

Source files

• nutkFilmWallFunctionFvPatchScalarField.H
• nutkFilmWallFunctionFvPatchScalarField.C

Definition at line 68 of file nutkFilmWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

nutkFilmWallFunctionFvPatchScalarField() [1/5]

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

Definition at line 149 of file nutkFilmWallFunctionFvPatchScalarField.C.

Referenced by nutkFilmWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

nutkFilmWallFunctionFvPatchScalarField() [2/5]

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

Definition at line 177 of file nutkFilmWallFunctionFvPatchScalarField.C.

nutkFilmWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 162 of file nutkFilmWallFunctionFvPatchScalarField.C.

nutkFilmWallFunctionFvPatchScalarField() [4/5]

nutkFilmWallFunctionFvPatchScalarField

(

const nutkFilmWallFunctionFvPatchScalarField &

wfpsf

)

Definition at line 194 of file nutkFilmWallFunctionFvPatchScalarField.C.

nutkFilmWallFunctionFvPatchScalarField() [5/5]

nutkFilmWallFunctionFvPatchScalarField	(	const nutkFilmWallFunctionFvPatchScalarField &	wfpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Definition at line 206 of file nutkFilmWallFunctionFvPatchScalarField.C.

Member Function Documentation

calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 120 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::calcUTau(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::max(), Foam::foamVersion::patch, turbulenceModel::propertiesName, and Foam::sqr().

Here is the call graph for this function:

calcUTau()

tmp< scalarField > calcUTau ( const scalarField &  magGradU ) const

protectedvirtual

Definition at line 43 of file nutkFilmWallFunctionFvPatchScalarField.C.

References Foam::exp(), forAll, Foam::constant::atomic::group, IOobject::groupName(), k, Foam::max(), Foam::min(), Foam::foamVersion::patch, Foam::pow(), turbulenceModel::propertiesName, tmp::ref(), Foam::sqrt(), uTau, y, yPlus, and Foam::Zero.

Referenced by nutkFilmWallFunctionFvPatchScalarField::calcNut(), and nutkFilmWallFunctionFvPatchScalarField::yPlus().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"nutkFilmWallFunction"

)

clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 136 of file nutkFilmWallFunctionFvPatchScalarField.H.

References nutkFilmWallFunctionFvPatchScalarField::nutkFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

clone() [2/2]

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

inlinevirtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 153 of file nutkFilmWallFunctionFvPatchScalarField.H.

References nutkFilmWallFunctionFvPatchScalarField::nutkFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

yPlus()

tmp< scalarField > yPlus ( ) const

virtual

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 220 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::calcUTau(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::foamVersion::patch, turbulenceModel::propertiesName, fvPatchField::snGrad(), and y.

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 242 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::B_, nutkFilmWallFunctionFvPatchScalarField::filmRegionName_, os(), fvPatchField::write(), nutWallFunctionFvPatchScalarField::writeLocalEntries(), and nutkFilmWallFunctionFvPatchScalarField::yPlusCrit_.

Here is the call graph for this function:

Member Data Documentation

filmRegionName_

word filmRegionName_

protected

Definition at line 77 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

B_

scalar B_

protected

Definition at line 80 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

yPlusCrit_

scalar yPlusCrit_

protected

Definition at line 83 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

---

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

• src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H
• src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.C