Runtime selectable DimensionedFieldFunction to set the turbulent kinetic energy, , for an atmospheric boundary layer. More...

Inheritance diagram for AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType >:

[legend]

Collaboration diagram for AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType >:

[legend]

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

	AtmosphericBoundaryLayerTurbulentKineticEnergy (const dictionary &dict, DimensionedFieldType &field)
	Construct with dictionary to initialise given field. More...

	AtmosphericBoundaryLayerTurbulentKineticEnergy (const AtmosphericBoundaryLayerTurbulentKineticEnergy &dff, DimensionedFieldType &field)
	Construct a copy for the given field. More...

virtual autoPtr< DimensionedFieldFunction< DimensionedFieldType > >	clone (DimensionedFieldType &field) const
	Construct and return a clone for the specified field. More...

virtual	~AtmosphericBoundaryLayerTurbulentKineticEnergy ()
	Destructor. More...

virtual void	evaluate ()
	Evaluate the function and set the field. More...

virtual void	write (Ostream &os) const
	Write data to dictionary stream. More...

Public Member Functions inherited from DimensionedFieldFunction< DimensionedFieldType >
	TypeName ("DimensionedFieldFunction")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, DimensionedFieldFunction, dictionary,(const dictionary &dict, DimensionedFieldType &field),(dict, field))

	DimensionedFieldFunction (const dictionary &dict, DimensionedFieldType &field)
	Construct with dictionary to initialise given field. More...

	DimensionedFieldFunction (const DimensionedFieldFunction &dff, DimensionedFieldType &field)
	Construct a copy for the given field. More...

	DimensionedFieldFunction (const DimensionedFieldFunction< DimensionedFieldType > &)=delete
	Disallow default bitwise copy construction. More...

virtual autoPtr< DimensionedFieldFunction< DimensionedFieldType > >	clone () const
	Construct and return a clone for the specified field. More...

virtual	~DimensionedFieldFunction ()
	Destructor. More...

virtual bool	update ()
	Update the field if the function has changed and return true. More...

virtual void	reset ()
	Reset the field size. More...

void	operator= (const DimensionedFieldFunction< DimensionedFieldType > &)=delete
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Member Functions inherited from DimensionedFieldFunction< DimensionedFieldType >
static autoPtr< DimensionedFieldFunction< DimensionedFieldType > >	New (const dictionary &dict, DimensionedFieldType &field)
	Select null constructed. More...

Protected Attributes inherited from DimensionedFieldFunction< DimensionedFieldType >
DimensionedFieldType &	field_
	Reference to the field the function applies to. More...

Detailed Description

template<class DimensionedFieldType>
class Foam::DimensionedFieldFunctions::AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType >

Runtime selectable DimensionedFieldFunction to set the turbulent kinetic energy, , for an atmospheric boundary layer.

See Foam::atmosphericBoundaryLayer for details.

Usage

Example to set the k internal field:

internalField
{
    type            atmosphericBoundaryLayerTurbulentKineticEnergy;
    libs            ("libatmosphericModels.so");
}

See also: Foam::atmosphericBoundaryLayer Foam::atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField

Source files

AtmosphericBoundaryLayerTurbulentKineticEnergy_DimensionedFieldFunction.H AtmosphericBoundaryLayerTurbulentKineticEnergy_
DimensionedFieldFunction.C

Definition at line 68 of file AtmosphericBoundaryLayerTurbulentKineticEnergy_DimensionedFieldFunction.H.

Constructor & Destructor Documentation

◆ AtmosphericBoundaryLayerTurbulentKineticEnergy() [1/2]

AtmosphericBoundaryLayerTurbulentKineticEnergy	(	const dictionary &	dict,
		DimensionedFieldType &	field
	)

Construct with dictionary to initialise given field.

Definition at line 34 of file AtmosphericBoundaryLayerTurbulentKineticEnergy_DimensionedFieldFunction.C.

◆ AtmosphericBoundaryLayerTurbulentKineticEnergy() [2/2]

AtmosphericBoundaryLayerTurbulentKineticEnergy	(	const AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType > &	dff,
		DimensionedFieldType &	field
	)