AtmosphericBoundaryLayerVelocity< DimensionedFieldType > Class Template Reference

Runtime selectable DimensionedFieldFunction to set the velocity for an atmospheric boundary layer. More...

Inheritance diagram for AtmosphericBoundaryLayerVelocity< DimensionedFieldType >:

Collaboration diagram for AtmosphericBoundaryLayerVelocity< DimensionedFieldType >:

Public Member Functions
	TypeName ("atmosphericBoundaryLayerVelocity")
	Runtime type information. More...
	AtmosphericBoundaryLayerVelocity (const dictionary &dict, DimensionedFieldType &field)
	Construct with dictionary to initialise given field. More...
	AtmosphericBoundaryLayerVelocity (const AtmosphericBoundaryLayerVelocity &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	~AtmosphericBoundaryLayerVelocity ()
	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::AtmosphericBoundaryLayerVelocity< DimensionedFieldType >

Runtime selectable DimensionedFieldFunction to set the velocity for an atmospheric boundary layer.

See Foam::atmosphericBoundaryLayer for details.

Usage

Example to set the U internal field:

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

Source files

• AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.H AtmosphericBoundaryLayerVelocity_
• DimensionedFieldFunction.C

Definition at line 65 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.H.

Constructor & Destructor Documentation

AtmosphericBoundaryLayerVelocity() [1/2]

AtmosphericBoundaryLayerVelocity	(	const dictionary &	dict,
		DimensionedFieldType &	field
	)

Construct with dictionary to initialise given field.

Definition at line 34 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.C.

AtmosphericBoundaryLayerVelocity() [2/2]

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

Construct a copy for the given field.

Definition at line 47 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.C.

~AtmosphericBoundaryLayerVelocity()

virtual ~AtmosphericBoundaryLayerVelocity ( )

inlinevirtual

Destructor.

Definition at line 101 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.H.

Member Function Documentation

TypeName()

TypeName

(

"atmosphericBoundaryLayerVelocity"

)

Runtime type information.

clone()

Foam::autoPtr< Foam::DimensionedFieldFunction< DimensionedFieldType > > clone ( DimensionedFieldType &  field ) const

virtual

Construct and return a clone for the specified field.

Implements DimensionedFieldFunction< DimensionedFieldType >.

Definition at line 61 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.C.

evaluate()

void evaluate

virtual

Evaluate the function and set the field.

Implements DimensionedFieldFunction< DimensionedFieldType >.

Definition at line 77 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.C.

References atmosphericBoundaryLayer::New(), and atmosphericBoundaryLayer::U().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Write data to dictionary stream.

Implements DimensionedFieldFunction< DimensionedFieldType >.

Definition at line 89 of file AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.C.

---

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

• src/atmosphericModels/DimensionedFieldFunctions/AtmosphericBoundaryLayerVelocity/AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.H
• src/atmosphericModels/DimensionedFieldFunctions/AtmosphericBoundaryLayerVelocity/AtmosphericBoundaryLayerVelocity_DimensionedFieldFunction.C