OpenFOAM logo
Open Source CFD Toolkit

TimeState Class Reference

Inheritance diagram for TimeState:

Inheritance graph
[legend]
Collaboration diagram for TimeState:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TimeState ()
virtual ~TimeState ()
 Virtual destructor.
virtual scalar userTimeToTime (const scalar theta) const
 Convert the user-time (e.g. CA deg) to real-time (s).
virtual scalar timeToUserTime (const scalar t) const
 Convert the real-time (s) into user-time (e.g. CA deg).
virtual scalar timeOutputValue () const
 Return current time value.
virtual label timeIndex () const
 Return current time index.
virtual dimensionedScalar deltaT () const
 Return time step.
virtual dimensionedScalar deltaT0 () const
 Return old time step.
virtual bool outputTime () const
 Return true if this is an output time.

Protected Attributes

label timeIndex_
scalar deltaT_
scalar deltaTSave_
scalar deltaT0_
bool deltaTchanged_
label outputTimeIndex_
bool outputTime_

Constructor & Destructor Documentation

TimeState  ) 
 

virtual ~TimeState  )  [virtual]
 

Virtual destructor.


Member Function Documentation

virtual dimensionedScalar deltaT  )  const [virtual]
 

Return time step.

Referenced by spray::evaporationSource().

virtual dimensionedScalar deltaT0  )  const [virtual]
 

Return old time step.

virtual bool outputTime  )  const [virtual]
 

Return true if this is an output time.

virtual label timeIndex  )  const [virtual]
 

Return current time index.

virtual scalar timeOutputValue  )  const [virtual]
 

Return current time value.

virtual scalar timeToUserTime const scalar  t  )  const [virtual]
 

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

Reimplemented in engineTime.

virtual scalar userTimeToTime const scalar  theta  )  const [virtual]
 

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

Reimplemented in engineTime.


Member Data Documentation

scalar deltaT0_ [protected]
 

Definition at line 67 of file TimeState.H.

scalar deltaT_ [protected]
 

Definition at line 65 of file TimeState.H.

bool deltaTchanged_ [protected]
 

Definition at line 68 of file TimeState.H.

scalar deltaTSave_ [protected]
 

Definition at line 66 of file TimeState.H.

bool outputTime_ [protected]
 

Definition at line 71 of file TimeState.H.

label outputTimeIndex_ [protected]
 

Definition at line 70 of file TimeState.H.

label timeIndex_ [protected]
 

Definition at line 64 of file TimeState.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org