real Class Reference

A simple userTime which simply returns the real-time is seconds. More...

Inheritance diagram for real:

Collaboration diagram for real:

Public Member Functions
	TypeName ("real")
	Runtime type information. More...
	real (const dictionary &controlDict)
	Construct from controlDict. More...
virtual	~real ()
	Destructor. More...
virtual scalar	userTimeToTime (const scalar tau) const
	Return tau (s) More...
virtual scalar	timeToUserTime (const scalar t) const
	Return t (s) More...
virtual word	unitName () const
	Return real-time unit name (s) More...
virtual const unitConversion &	units () const
	Return the real-time unit conversion. More...
virtual bool	read (const dictionary &controlDict)
	Read the controlDict and set all the parameters. More...
Public Member Functions inherited from userTime
	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...

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

Detailed Description

A simple userTime which simply returns the real-time is seconds.

Source files

• realTime.H
• realTime.C

Definition at line 51 of file realTime.H.

Constructor & Destructor Documentation

real()

real

(

const dictionary &

controlDict

)

Construct from controlDict.

Definition at line 43 of file realTime.C.

~real()

~real ( )

virtual

Destructor.

Definition at line 51 of file realTime.C.

Member Function Documentation

TypeName()

TypeName

(

"real"

)

Runtime type information.

userTimeToTime()

Foam::scalar userTimeToTime ( const scalar  tau ) const

virtual

Return tau (s)

Implements userTime.

Definition at line 57 of file realTime.C.

References tau.

timeToUserTime()

Foam::scalar timeToUserTime ( const scalar  t ) const

virtual

Return t (s)

Implements userTime.

Definition at line 63 of file realTime.C.

unitName()

Foam::word unitName ( ) const

virtual

Return real-time unit name (s)

Implements userTime.

Definition at line 69 of file realTime.C.

units()

const Foam::unitConversion & units ( ) const

virtual

Return the real-time unit conversion.

Implements userTime.

Definition at line 75 of file realTime.C.

References Foam::dimTime.

read()

bool read ( const dictionary &  controlDict )

virtual

Read the controlDict and set all the parameters.

Implements userTime.

Definition at line 82 of file realTime.C.

---

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

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