userTime Class Reference

Inheritance diagram for userTime:

Public Member Functions
	TypeName ("userTime")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, userTime, dictionary,(const dictionary &controlDict),(controlDict))
	Declare runtime constructor selection table. More...
	userTime (const dictionary &controlDict)
	Construct from controlDict. More...
virtual	~userTime ()
	Destructor. More...
virtual scalar	userTimeToTime (const scalar tau) const =0
	Convert the user-time (e.g. CA deg) to real-time (s). More...
virtual scalar	timeToUserTime (const scalar t) const =0
	Convert the real-time (s) into user-time (e.g. CA deg) More...
virtual word	unit () const =0
	Return user-time unit. More...
virtual bool	read (const dictionary &controlDict)=0
	Read the controlDict and set all the parameters. More...

Static Public Member Functions
static autoPtr< userTime >	New (const dictionary &controlDict)
static const dictionary &	dict (const dictionary &controlDict)
	Return the userTime sub-dictionary. More...

Detailed Description

Definition at line 51 of file userTime.H.

Constructor & Destructor Documentation

userTime()

userTime

(

const dictionary &

controlDict

)

Construct from controlDict.

Definition at line 42 of file userTime.C.

~userTime()

~userTime ( )

virtual

Destructor.

Definition at line 48 of file userTime.C.

Member Function Documentation

TypeName()

TypeName

(

"userTime"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		userTime	,
		dictionary	,
		(const dictionary &controlDict)	,
		(controlDict)
	)

Declare runtime constructor selection table.

New()

Foam::autoPtr< Foam::userTimes::userTime > New ( const dictionary &  controlDict )

static

Definition at line 31 of file userTimeNew.C.

References controlDict(), userTime::dict(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::nl, and Foam::type().

Here is the call graph for this function:

dict()

const Foam::dictionary & dict ( const dictionary &  controlDict )

static

Return the userTime sub-dictionary.

Definition at line 54 of file userTime.C.

References controlDict().

Referenced by userTime::New().

Here is the call graph for this function:

Here is the caller graph for this function:

userTimeToTime()

virtual scalar userTimeToTime ( const scalar  tau ) const

pure virtual

Convert the user-time (e.g. CA deg) to real-time (s).

Implemented in engine, and real.

timeToUserTime()

virtual scalar timeToUserTime ( const scalar  t ) const

pure virtual

Convert the real-time (s) into user-time (e.g. CA deg)

Implemented in real, and engine.

unit()

virtual word unit ( ) const

pure virtual

Return user-time unit.

Implemented in real, and engine.

read()

virtual bool read ( const dictionary &  controlDict )

pure virtual

Read the controlDict and set all the parameters.

Implemented in real, and engine.

---

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

• src/OpenFOAM/db/Time/userTime/userTime/userTime.H
• src/OpenFOAM/db/Time/userTime/userTime/userTime.C
• src/OpenFOAM/db/Time/userTime/userTime/userTimeNew.C