Public Member Functions | Protected Attributes | Friends | List of all members
TimeFunction1< Type > Class Template Reference

Light wrapper around Function1 to provide a mechanism to update time-based entries. More...

Inheritance diagram for TimeFunction1< Type >:
[legend]
Collaboration diagram for TimeFunction1< Type >:
[legend]

Public Member Functions

 TimeFunction1 (const Time &runTime, const word &name, const dictionary &dict)
 Construct from entry name and dictionary. More...
 
 TimeFunction1 (const Time &runTime, const word &entryName)
 Construct from entry name. More...
 
 TimeFunction1 (const TimeFunction1< Type > &rhs)
 Copy construct. More...
 
virtual ~TimeFunction1 ()=default
 Destructor. More...
 
void reset (const dictionary &dict)
 Reset entry by re-reading from dictionary. More...
 
const word & name () const
 Return the name of the entry. More...
 
virtual Type value (const scalar x) const
 Return value as a function of (scalar) independent variable. More...
 
virtual Type integrate (const scalar x1, const scalar x2) const
 Integrate between two (scalar) values. More...
 
virtual void writeData (Ostream &os) const
 Write in dictionary format. More...
 

Protected Attributes

const Time & time_
 Reference to the time database. More...
 
const word name_
 Name of the data entry. More...
 
autoPtr< Function1< Type > > entry_
 The underlying Function1. More...
 

Friends

Ostream & operator (Ostream &os, const TimeFunction1< Type > &de)
 Ostream Operator. More...
 

Detailed Description

template<class Type>
class Foam::TimeFunction1< Type >

Light wrapper around Function1 to provide a mechanism to update time-based entries.

Source files

Definition at line 80 of file ConeNozzleInjection.H.

Constructor & Destructor Documentation

◆ TimeFunction1() [1/3]

TimeFunction1 ( const Time &  runTime,
const word &  name,
const dictionary &  dict 
)

Construct from entry name and dictionary.

Definition at line 35 of file TimeFunction1.C.

◆ TimeFunction1() [2/3]

TimeFunction1 ( const Time &  runTime,
const word &  entryName 
)

Construct from entry name.

Definition at line 51 of file TimeFunction1.C.

◆ TimeFunction1() [3/3]

TimeFunction1 ( const TimeFunction1< Type > &  rhs)

Copy construct.

Definition at line 64 of file TimeFunction1.C.

◆ ~TimeFunction1()

virtual ~TimeFunction1 ( )
virtualdefault

Destructor.

Member Function Documentation

◆ reset()

void reset ( const dictionary &  dict)

Reset entry by re-reading from dictionary.

Definition at line 82 of file TimeFunction1.C.

◆ name()

const Foam::word & name ( ) const

Return the name of the entry.

Definition at line 90 of file TimeFunction1.C.

Referenced by atmBoundaryLayer::Ustar().

Here is the caller graph for this function:

◆ value()

Type value ( const scalar  x) const
virtual

Return value as a function of (scalar) independent variable.

Definition at line 97 of file TimeFunction1.C.

Referenced by atmAlphatkWallFunctionFvPatchScalarField::updateCoeffs(), atmTurbulentHeatFluxTemperatureFvPatchScalarField::updateCoeffs(), and atmBoundaryLayer::Ustar().

Here is the caller graph for this function:

◆ integrate()

Type integrate ( const scalar  x1,
const scalar  x2 
) const
virtual

Integrate between two (scalar) values.

Definition at line 105 of file TimeFunction1.C.

◆ writeData()

void writeData ( Ostream &  os) const
virtual

Write in dictionary format.

Definition at line 132 of file TimeFunction1.C.

Referenced by atmTurbulentHeatFluxTemperatureFvPatchScalarField::write(), atmAlphatkWallFunctionFvPatchScalarField::write(), and atmBoundaryLayer::write().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator ( Ostream &  os,
const TimeFunction1< Type > &  de 
)
friend

Ostream Operator.

Member Data Documentation

◆ time_

const Time& time_
protected

Reference to the time database.

Definition at line 67 of file TimeFunction1.H.

◆ name_

const word name_
protected

Name of the data entry.

Definition at line 70 of file TimeFunction1.H.

◆ entry_

autoPtr<Function1<Type> > entry_
protected

The underlying Function1.

Definition at line 73 of file TimeFunction1.H.

Referenced by TimeFunction1< Foam::Vector >::TimeFunction1().

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