TimeFunction1< Type > Class Template Reference

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

Inheritance diagram for TimeFunction1< Type >:

Collaboration diagram for TimeFunction1< Type >:

Public Member Functions
	TimeFunction1 (const Time &t, const word &name, const dictionary &dict)
	Construct from entry name. More...
	TimeFunction1 (const Time &t, const word &entryName)
	Construct null from entry 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...
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

• TimeFunction1.H
• TimeFunction1.C

Definition at line 73 of file ConeNozzleInjection.H.

Constructor & Destructor Documentation

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

Construct from entry name.

Definition at line 32 of file TimeFunction1.C.

Referenced by TimeFunction1< Type >::TimeFunction1().

Here is the caller graph for this function:

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

Construct null from entry name.

Definition at line 47 of file TimeFunction1.C.

References TimeFunction1< Type >::TimeFunction1().

Here is the call graph for this function:

TimeFunction1

(

const TimeFunction1< Type > &

tde

)

Copy constructor.

Definition at line 57 of file TimeFunction1.C.

References TimeFunction1< Type >::entry_.

~TimeFunction1 ( )

virtual

Destructor.

Definition at line 75 of file TimeFunction1.C.

Member Function Documentation

void reset

(

const dictionary &

dict

)

Reset entry by re-reading from dictionary.

Definition at line 82 of file TimeFunction1.C.

References TimeFunction1< Type >::entry_, TimeFunction1< Type >::name_, and TimeFunction1< Type >::time_.

Referenced by InjectionModel< CloudType >::InjectionModel().

Here is the caller graph for this function:

const Foam::word & name

(

)

const

Return the name of the entry.

Definition at line 98 of file TimeFunction1.C.

References TimeFunction1< Type >::entry_.

Type value ( const scalar  x ) const

virtual

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

Definition at line 105 of file TimeFunction1.C.

References TimeFunction1< Type >::entry_, and TimeFunction1< Type >::integrate().

Referenced by InjectionModel< CloudType >::InjectionModel(), and InjectionModel< CloudType >::injectSteadyState().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Integrate between two (scalar) values.

Definition at line 113 of file TimeFunction1.C.

References TimeFunction1< Type >::entry_.

Referenced by TimeFunction1< Type >::value().

Here is the caller graph for this function:

void writeData ( Ostream &  os ) const

virtual

Write in dictionary format.

Definition at line 136 of file TimeFunction1.C.

References TimeFunction1< Type >::entry_.

Friends And Related Function Documentation

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

friend

Ostream Operator.

Member Data Documentation

const Time& time_

protected

Reference to the time database.

Definition at line 68 of file TimeFunction1.H.

Referenced by TimeFunction1< Type >::reset().

const word name_

protected

Name of the data entry.

Definition at line 71 of file TimeFunction1.H.

Referenced by TimeFunction1< Type >::reset().

autoPtr<Function1<Type> > entry_

protected

The underlying Function1.

Definition at line 74 of file TimeFunction1.H.

Referenced by TimeFunction1< Type >::integrate(), TimeFunction1< Type >::name(), TimeFunction1< Type >::reset(), TimeFunction1< Type >::TimeFunction1(), TimeFunction1< Type >::value(), and TimeFunction1< Type >::writeData().

---

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

• src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H
• src/OpenFOAM/primitives/functions/TimeFunction1/TimeFunction1.H
• src/OpenFOAM/primitives/functions/TimeFunction1/TimeFunction1.C