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 >:
Inheritance graph
[legend]
Collaboration diagram for TimeFunction1< Type >:
Collaboration graph
[legend]

Public Member Functions

 TimeFunction1 (const Time &time, const word &name, const dictionary &dict)
 Construct from time, name and dictionary. More...
 
 TimeFunction1 (const Time &time, const Function1< Type > &function)
 Construct from time and Function1. More...
 
 TimeFunction1 (const Time &time, const word &name)
 Construct null from time and name. More...
 
 TimeFunction1 (const TimeFunction1< Type > &tde)
 Copy constructor. More...
 
virtual ~TimeFunction1 ()
 Destructor. More...
 
void reset (const dictionary &dict)
 Reset entry by re-reading from dictionary. More...
 
virtual Type value (const scalar x) const
 Return value as a function of scalar x. More...
 
virtual Type integral (const scalar x1, const scalar x2) const
 Integrate between two scalars. More...
 
virtual void write (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 > > function_
 The function. 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 60 of file TimeFunction1.H.

Constructor & Destructor Documentation

◆ TimeFunction1() [1/4]

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

Construct from time, name and dictionary.

Definition at line 31 of file TimeFunction1.C.

◆ TimeFunction1() [2/4]

TimeFunction1 ( const Time &  time,
const Function1< Type > &  function 
)

Construct from time and Function1.

Definition at line 45 of file TimeFunction1.C.

◆ TimeFunction1() [3/4]

TimeFunction1 ( const Time &  time,
const word &  name 
)

Construct null from time and name.

Definition at line 58 of file TimeFunction1.C.

◆ TimeFunction1() [4/4]

TimeFunction1 ( const TimeFunction1< Type > &  tde)

Copy constructor.

Definition at line 71 of file TimeFunction1.C.

◆ ~TimeFunction1()

~TimeFunction1
virtual

Destructor.

Definition at line 85 of file TimeFunction1.C.

Member Function Documentation

◆ reset()

void reset ( const dictionary &  dict)

Reset entry by re-reading from dictionary.

Definition at line 92 of file TimeFunction1.C.

References dict.

◆ value()

Type value ( const scalar  x) const
virtual

Return value as a function of scalar x.

Definition at line 99 of file TimeFunction1.C.

References x.

◆ integral()

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

Integrate between two scalars.

Definition at line 106 of file TimeFunction1.C.

◆ write()

void write ( Ostream &  os) const
virtual

Write in dictionary format.

Definition at line 123 of file TimeFunction1.C.

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.

◆ function_

autoPtr<Function1<Type> > function_
protected

The function.

Definition at line 73 of file TimeFunction1.H.

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