atmAlphatkWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a wall constraint on the kinematic turbulent thermal conductivity (i.e. alphat) for atmospheric boundary layer modelling. It assumes a logarithmic distribution of the potential temperature within the first cell. More...

Inheritance diagram for atmAlphatkWallFunctionFvPatchScalarField:

Collaboration diagram for atmAlphatkWallFunctionFvPatchScalarField:

Public Member Functions
	TypeName ("atmAlphatkWallFunction")
	atmAlphatkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	atmAlphatkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	atmAlphatkWallFunctionFvPatchScalarField (const atmAlphatkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	atmAlphatkWallFunctionFvPatchScalarField (const atmAlphatkWallFunctionFvPatchScalarField &)
virtual tmp< fvPatchScalarField >	clone () const
	atmAlphatkWallFunctionFvPatchScalarField (const atmAlphatkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
virtual void	updateCoeffs ()
virtual void	autoMap (const fvPatchFieldMapper &)
virtual void	rmap (const fvPatchScalarField &, const labelList &)
virtual void	write (Ostream &) const

Protected Member Functions
virtual void	checkType ()

Protected Attributes
const scalar	Cmu_
const scalar	kappa_
autoPtr< Function1< scalar > >	Pr_
autoPtr< PatchFunction1< scalar > >	Prt_
autoPtr< PatchFunction1< scalar > >	z0_

Static Protected Attributes
static scalar	tolerance_ = 0.01
static label	maxIters_ = 10

Detailed Description

This boundary condition provides a wall constraint on the kinematic turbulent thermal conductivity (i.e. alphat) for atmospheric boundary layer modelling. It assumes a logarithmic distribution of the potential temperature within the first cell.

Required fields:

  alphat    | Kinematic turbulent thermal conductivity    [m2/s]

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type            atmAlphatkWallFunction;

    // Mandatory entries (runtime modifiable)
    Pr              0.90;
    Prt             uniform 0.85;
    z0              uniform 0.001;

    // Optional entries (unmodifiable)
    Cmu             0.09;
    kappa           0.41;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
type	Type name: atmAlphatkWallFunction	word	yes	-
Pr	Molecular Prandtl number	Function1<scalar>	yes	-
Prt	Turbulent Prandtl number	PatchFunction1<scalar>	yes	-
z0	Surface roughness length [m]	PatchFunction1<scalar>	yes	-
Cmu	Empirical model constant	scalar	no	0.09
kappa	von Kármán constant	scalar	no	0.41

The inherited entries are elaborated in:

• fixedValueFvPatchField.H
• Function1.H
• PatchFunction1.H

See also

• Foam::fixedValueFvPatchField

Source files

• atmAlphatkWallFunctionFvPatchScalarField.H
• atmAlphatkWallFunctionFvPatchScalarField.C

Definition at line 145 of file atmAlphatkWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

atmAlphatkWallFunctionFvPatchScalarField() [1/5]

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

Definition at line 61 of file atmAlphatkWallFunctionFvPatchScalarField.C.

Referenced by atmAlphatkWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

atmAlphatkWallFunctionFvPatchScalarField() [2/5]

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

Definition at line 99 of file atmAlphatkWallFunctionFvPatchScalarField.C.

atmAlphatkWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 79 of file atmAlphatkWallFunctionFvPatchScalarField.C.

atmAlphatkWallFunctionFvPatchScalarField() [4/5]

atmAlphatkWallFunctionFvPatchScalarField

(

const atmAlphatkWallFunctionFvPatchScalarField &

wfpsf

)

Definition at line 134 of file atmAlphatkWallFunctionFvPatchScalarField.C.

atmAlphatkWallFunctionFvPatchScalarField() [5/5]

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

Definition at line 151 of file atmAlphatkWallFunctionFvPatchScalarField.C.

Member Function Documentation

checkType()

void checkType ( )

protectedvirtual

Definition at line 43 of file atmAlphatkWallFunctionFvPatchScalarField.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Foam::foamVersion::patch.

Here is the call graph for this function:

TypeName()

TypeName

(

"atmAlphatkWallFunction"

)

clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Definition at line 222 of file atmAlphatkWallFunctionFvPatchScalarField.H.

References atmAlphatkWallFunctionFvPatchScalarField::atmAlphatkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

clone() [2/2]

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

inlinevirtual

Definition at line 239 of file atmAlphatkWallFunctionFvPatchScalarField.H.

References atmAlphatkWallFunctionFvPatchScalarField::atmAlphatkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

updateCoeffs()

void updateCoeffs ( )

virtual

Definition at line 169 of file atmAlphatkWallFunctionFvPatchScalarField.C.

References atmAlphatkWallFunctionFvPatchScalarField::Cmu_, Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::atomic::group, IOobject::groupName(), k, atmAlphatkWallFunctionFvPatchScalarField::kappa_, Foam::log(), Foam::max(), Foam::foamVersion::patch, Foam::pow025(), Pr(), atmAlphatkWallFunctionFvPatchScalarField::Pr_, turbulenceModel::propertiesName, Prt(), atmAlphatkWallFunctionFvPatchScalarField::Prt_, Foam::sqrt(), fvPatchField< Type >::updateCoeffs(), y, and atmAlphatkWallFunctionFvPatchScalarField::z0_.

Here is the call graph for this function:

autoMap()

void autoMap ( const fvPatchFieldMapper &  m )

virtual

Definition at line 254 of file atmAlphatkWallFunctionFvPatchScalarField.C.

rmap()

void rmap ( const fvPatchScalarField &  ptf, const labelList &  addr  )

virtual

Definition at line 265 of file atmAlphatkWallFunctionFvPatchScalarField.C.

References atmAlphatkWallFunctionFvPatchScalarField::Prt_, and atmAlphatkWallFunctionFvPatchScalarField::z0_.

write()

void write ( Ostream &  os ) const

virtual

Definition at line 280 of file atmAlphatkWallFunctionFvPatchScalarField.C.

References atmAlphatkWallFunctionFvPatchScalarField::Cmu_, atmAlphatkWallFunctionFvPatchScalarField::kappa_, os(), atmAlphatkWallFunctionFvPatchScalarField::Pr_, atmAlphatkWallFunctionFvPatchScalarField::Prt_, fvPatchField::write(), and atmAlphatkWallFunctionFvPatchScalarField::z0_.

Here is the call graph for this function:

Member Data Documentation

Cmu_

const scalar Cmu_

protected

Definition at line 154 of file atmAlphatkWallFunctionFvPatchScalarField.H.

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

kappa_

const scalar kappa_

protected

Definition at line 157 of file atmAlphatkWallFunctionFvPatchScalarField.H.

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

Pr_

autoPtr<Function1<scalar> > Pr_

protected

Definition at line 160 of file atmAlphatkWallFunctionFvPatchScalarField.H.

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

Prt_

autoPtr<PatchFunction1<scalar> > Prt_

protected

Definition at line 163 of file atmAlphatkWallFunctionFvPatchScalarField.H.

Referenced by atmAlphatkWallFunctionFvPatchScalarField::rmap(), atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), and atmAlphatkWallFunctionFvPatchScalarField::write().

z0_

autoPtr<PatchFunction1<scalar> > z0_

protected

Definition at line 166 of file atmAlphatkWallFunctionFvPatchScalarField.H.

Referenced by atmAlphatkWallFunctionFvPatchScalarField::rmap(), atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), and atmAlphatkWallFunctionFvPatchScalarField::write().

tolerance_

scalar tolerance_ = 0.01

staticprotected

Definition at line 171 of file atmAlphatkWallFunctionFvPatchScalarField.H.

maxIters_

label maxIters_ = 10

staticprotected

Definition at line 172 of file atmAlphatkWallFunctionFvPatchScalarField.H.

---

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

• src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmAlphatkWallFunction/atmAlphatkWallFunctionFvPatchScalarField.H
• src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmAlphatkWallFunction/atmAlphatkWallFunctionFvPatchScalarField.C