Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
DimensionedFieldFunction< DimensionedFieldType > Class Template Referenceabstract

Base class for run-time selectable internal and patch field initialisation evaluation and update with dimension checking. More...

Inheritance diagram for DimensionedFieldFunction< DimensionedFieldType >:
Inheritance graph
[legend]

Public Member Functions

 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 (DimensionedFieldType &field) const =0
 Construct and return a clone for the specified field. More...
 
virtual autoPtr< DimensionedFieldFunction< DimensionedFieldType > > clone () const
 Construct and return a clone for the specified field. More...
 
virtual ~DimensionedFieldFunction ()
 Destructor. More...
 
virtual void evaluate ()=0
 Evaluate the function and set the field. More...
 
virtual bool update ()
 Update the field if the function has changed and return true. More...
 
virtual void reset ()
 Reset the field size. More...
 
virtual void write (Ostream &os) const =0
 Write data to dictionary stream. More...
 
void operator= (const DimensionedFieldFunction< DimensionedFieldType > &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< DimensionedFieldFunction< DimensionedFieldType > > New (const dictionary &dict, DimensionedFieldType &field)
 Select null constructed. More...
 

Protected Attributes

DimensionedFieldType & field_
 Reference to the field the function applies to. More...
 

Detailed Description

template<class DimensionedFieldType>
class Foam::DimensionedFieldFunction< DimensionedFieldType >

Base class for run-time selectable internal and patch field initialisation evaluation and update with dimension checking.

Source files

Definition at line 51 of file DimensionedFieldFunction.H.

Constructor & Destructor Documentation

◆ DimensionedFieldFunction() [1/3]

DimensionedFieldFunction ( const dictionary &  dict,
DimensionedFieldType &  field 
)

Construct with dictionary to initialise given field.

Definition at line 32 of file DimensionedFieldFunction.C.

◆ DimensionedFieldFunction() [2/3]

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

Construct a copy for the given field.

Definition at line 43 of file DimensionedFieldFunction.C.

◆ DimensionedFieldFunction() [3/3]

DimensionedFieldFunction ( const DimensionedFieldFunction< DimensionedFieldType > &  )
delete

Disallow default bitwise copy construction.

◆ ~DimensionedFieldFunction()

virtual ~DimensionedFieldFunction ( )
inlinevirtual

Destructor.

Definition at line 130 of file DimensionedFieldFunction.H.

Member Function Documentation

◆ TypeName()

TypeName ( "DimensionedFieldFunction< DimensionedFieldType >"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone() [1/2]

virtual autoPtr<DimensionedFieldFunction<DimensionedFieldType> > clone ( DimensionedFieldType &  field) const
pure virtual

Construct and return a clone for the specified field.

Implemented in Zonal< DimensionedFieldType >, Zonal< DimensionedFieldType >, TimeFunction< DimensionedFieldType >, Surfaces< DimensionedFieldType >, FieldFunction< DimensionedFieldType >, DistanceFunction< DimensionedFieldType >, Coded< DimensionedFieldType >, AtmosphericBoundaryLayerVelocity< DimensionedFieldType >, AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType >, AtmosphericBoundaryLayerTurbulentEpsilon< DimensionedFieldType >, waveVelocity, wallLayersHeatTransferCoefficient, externalWallLayersHeatTransferCoefficient, displacementGapHeatTransferCoefficient, and waveAlpha.

◆ clone() [2/2]

virtual autoPtr<DimensionedFieldFunction<DimensionedFieldType> > clone ( ) const
inlinevirtual

Construct and return a clone for the specified field.

Definition at line 109 of file DimensionedFieldFunction.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::DimensionedFieldFunction< DimensionedFieldType > > New ( const dictionary &  dict,
DimensionedFieldType &  field 
)
static

Select null constructed.

Definition at line 57 of file DimensionedFieldFunction.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::libs, dictionary::lookup(), Foam::nl, dlLibraryTable::open(), and Foam::type().

Referenced by Coded< DimensionedFieldType >::evaluate(), and Coded< DimensionedFieldType >::update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evaluate()

virtual void evaluate ( )
pure virtual

Evaluate the function and set the field.

Implemented in waveVelocity, waveAlpha, wallLayersHeatTransferCoefficient, externalWallLayersHeatTransferCoefficient, Zonal< DimensionedFieldType >, Zonal< DimensionedFieldType >, TimeFunction< DimensionedFieldType >, Surfaces< DimensionedFieldType >, FieldFunction< DimensionedFieldType >, DistanceFunction< DimensionedFieldType >, Coded< DimensionedFieldType >, AtmosphericBoundaryLayerVelocity< DimensionedFieldType >, AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType >, AtmosphericBoundaryLayerTurbulentEpsilon< DimensionedFieldType >, and displacementGapHeatTransferCoefficient.

Referenced by DimensionedFieldFunction< DimensionedFieldType >::reset().

Here is the caller graph for this function:

◆ update()

virtual bool update ( )
inlinevirtual

Update the field if the function has changed and return true.

otherwise return false

Reimplemented in TimeFunction< DimensionedFieldType >, FieldFunction< DimensionedFieldType >, Coded< DimensionedFieldType >, and displacementGapHeatTransferCoefficient.

Definition at line 141 of file DimensionedFieldFunction.H.

◆ reset()

virtual void reset ( )
inlinevirtual

Reset the field size.

Definition at line 147 of file DimensionedFieldFunction.H.

References DimensionedFieldFunction< DimensionedFieldType >::evaluate(), and DimensionedFieldFunction< DimensionedFieldType >::field_.

Here is the call graph for this function:

◆ write()

virtual void write ( Ostream &  os) const
pure virtual

Write data to dictionary stream.

Implemented in waveVelocity, waveAlpha, wallLayersHeatTransferCoefficient, externalWallLayersHeatTransferCoefficient, Zonal< DimensionedFieldType >, Zonal< DimensionedFieldType >, TimeFunction< DimensionedFieldType >, Surfaces< DimensionedFieldType >, FieldFunction< DimensionedFieldType >, DistanceFunction< DimensionedFieldType >, Coded< DimensionedFieldType >, AtmosphericBoundaryLayerVelocity< DimensionedFieldType >, AtmosphericBoundaryLayerTurbulentKineticEnergy< DimensionedFieldType >, AtmosphericBoundaryLayerTurbulentEpsilon< DimensionedFieldType >, and displacementGapHeatTransferCoefficient.

◆ operator=()

void operator= ( const DimensionedFieldFunction< DimensionedFieldType > &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ field_

DimensionedFieldType& field_
protected

Reference to the field the function applies to.

Definition at line 57 of file DimensionedFieldFunction.H.

Referenced by DimensionedFieldFunction< DimensionedFieldType >::reset().

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