TimeFunction1 Class Reference

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

Collaboration diagram for TimeFunction1:

Public Member Functions
	TimeFunction1 (const Time &runTime, const word &name, const dictionary &dict)
	TimeFunction1 (const Time &runTime, const word &entryName)
	TimeFunction1 (const TimeFunction1< Type > &rhs)
virtual	~TimeFunction1 ()=default
void	reset (const dictionary &dict)
const word &	name () const
virtual Type	value (const scalar x) const
virtual Type	integrate (const scalar x1, const scalar x2) const
virtual void	writeData (Ostream &os) const

Protected Attributes
const Time &	time_
const word	name_
autoPtr< Function1< Type > >	entry_

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

Detailed Description

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

Source files

• TimeFunction1.H
• TimeFunction1.C

Definition at line 46 of file TimeFunction1.H.

Constructor & Destructor Documentation

TimeFunction1() [1/3]

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

TimeFunction1() [2/3]

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

Definition at line 45 of file TimeFunction1.C.

TimeFunction1() [3/3]

TimeFunction1

(

const TimeFunction1< Type > &

rhs

)

Definition at line 58 of file TimeFunction1.C.

References TimeFunction1::entry_.

~TimeFunction1()

virtual ~TimeFunction1 ( )

virtualdefault

Member Function Documentation

reset()

void reset

(

const dictionary &

dict

)

Definition at line 76 of file TimeFunction1.C.

References dict.

name()

const Foam::word & name

(

)

const

Definition at line 84 of file TimeFunction1.C.

value()

Type value ( const scalar  x ) const

virtual

Definition at line 91 of file TimeFunction1.C.

References x.

integrate()

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

virtual

Definition at line 99 of file TimeFunction1.C.

writeData()

void writeData ( Ostream &  os ) const

virtual

Definition at line 126 of file TimeFunction1.C.

References os().

Here is the call graph for this function:

Friends And Related Function Documentation

operator

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

friend

Member Data Documentation

time_

const Time& time_

protected

Definition at line 63 of file TimeFunction1.H.

name_

const word name_

protected

Definition at line 66 of file TimeFunction1.H.

entry_

autoPtr<Function1<Type> > entry_

protected

Definition at line 69 of file TimeFunction1.H.

Referenced by TimeFunction1::TimeFunction1().

---

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

• src/OpenFOAM/primitives/functions/TimeFunction1/TimeFunction1.H
• src/OpenFOAM/primitives/functions/TimeFunction1/TimeFunction1.C