This boundary condition provides a log-law type ground-normal inlet boundary condition for the streamwise component of wind velocity (i.e. u) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling. More...

Inheritance diagram for atmBoundaryLayerInletVelocityFvPatchVectorField:

[legend]

Collaboration diagram for atmBoundaryLayerInletVelocityFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("atmBoundaryLayerInletVelocity")
	Runtime type information. More...

	atmBoundaryLayerInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. More...

	atmBoundaryLayerInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	atmBoundaryLayerInletVelocityFvPatchVectorField (const atmBoundaryLayerInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given atmBoundaryLayerInletVelocityFvPatchVectorField onto a new patch. More...

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

virtual tmp< fvPatchField< vector > >	clone () const
	Return a clone. More...

virtual tmp< fvPatchField< vector > >	clone (const DimensionedField< vector, volMesh > &iF) const
	Clone with an internal field reference. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchVectorField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from atmBoundaryLayer
	atmBoundaryLayer (const Time &time, const polyPatch &pp)
	Construct null from time. More...

	atmBoundaryLayer (const Time &time, const polyPatch &pp, const dictionary &dict)
	Construct from the time database and dictionary. More...

	atmBoundaryLayer (const atmBoundaryLayer &abl, const fvPatch &patch, const fvPatchFieldMapper &mapper)
	Construct by mapping given atmBoundaryLayer onto a new patch. More...

	atmBoundaryLayer (const atmBoundaryLayer &)
	Construct as copy. More...

vector	flowDir () const
	Return flow direction. More...

vector	zDir () const
	Return the ground-normal direction. More...

tmp< scalarField >	Ustar (const scalarField &z0) const
	Return friction velocity. More...

void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

void	rmap (const atmBoundaryLayer &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

tmp< vectorField >	U (const vectorField &pCf) const
	Return the velocity distribution for the ATM. More...

tmp< scalarField >	k (const vectorField &pCf) const
	Return the turbulent kinetic energy distribution for the ATM. More...

tmp< scalarField >	epsilon (const vectorField &pCf) const
	Return the turbulent dissipation rate distribution for the ATM. More...

tmp< scalarField >	omega (const vectorField &pCf) const
	Return the specific dissipation rate distribution for the ATM. More...

void	write (Ostream &) const
	Write. More...

Additional Inherited Members
Protected Attributes inherited from atmBoundaryLayer
bool	initABL_
	Flag to initialise profiles with the theoretical ABL expressions, otherwise initialises by using "value" entry content. More...

Detailed Description

This boundary condition provides a log-law type ground-normal inlet boundary condition for the streamwise component of wind velocity (i.e. u) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling.

The ground-normal streamwise flow speed profile expression:

$u = \frac{u^*}{\kappa} \ln \left( \frac{z - d + z_0}{z_0} \right)$

$v = w = 0$

where

	=	Ground-normal streamwise flow speed profile [m/s]
	=	Spanwise flow speed [m/s]
	=	Ground-normal flow speed [m/s]
	=	Friction velocity [m/s]
$\kappa$	=	von Kármán constant [-]
	=	Ground-normal coordinate component [m]
	=	Ground-normal displacement height [m]
	=	Aerodynamic roughness length [m]

Required fields:

        U   | Velocity                                          [m/s]

Usage

Example of the boundary condition specification:

inlet
{
    // Mandatory entries (unmodifiable)
    type            atmBoundaryLayerInletVelocity;

    // Mandatory/Optional (inherited) entries (unmodifiable)
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: atmBoundaryLayerInletVelocity	word	yes	-

The inherited entries are elaborated in:

See also

Source files

Definition at line 155 of file atmBoundaryLayerInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [1/4]

atmBoundaryLayerInletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [2/4]

atmBoundaryLayerInletVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 47 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References dict, atmBoundaryLayer::initABL_, IOobjectOption::MUST_READ, Field< vector >::operator=(), Foam::foamVersion::patch, atmBoundaryLayer::U(), and Foam::Zero.

Here is the call graph for this function:

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [3/4]

atmBoundaryLayerInletVelocityFvPatchVectorField	(	const atmBoundaryLayerInletVelocityFvPatchVectorField &	pvf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given atmBoundaryLayerInletVelocityFvPatchVectorField onto a new patch.

Definition at line 76 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [4/4]

atmBoundaryLayerInletVelocityFvPatchVectorField	(	const atmBoundaryLayerInletVelocityFvPatchVectorField &	pvf,
		const DimensionedField< vector, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 90 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletVelocity" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Return a clone.

Definition at line 214 of file atmBoundaryLayerInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 222 of file atmBoundaryLayerInletVelocityFvPatchVectorField.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 104 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References Foam::foamVersion::patch, and atmBoundaryLayer::U().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 117 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References atmBoundaryLayer::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap	(	const fvPatchVectorField &	pvf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 127 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 142 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References os(), atmBoundaryLayer::write(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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

src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H
src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [1/4]

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [2/4]

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [3/4]

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [4/4]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ autoMap()

◆ rmap()

◆ write()