TimeState Class Reference

The time value with time-stepping information, user-defined remapping, etc. More...

Inheritance diagram for TimeState:

[legend]

Collaboration diagram for TimeState:

[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_

---

Detailed Description

The time value with time-stepping information, user-defined remapping, etc.

Source files

• TimeState.H
• TimeState.C

Definition at line 45 of file TimeState.H.

---

Constructor & Destructor Documentation

TimeState

(

)

Definition at line 23 of file TimeState.C.

~TimeState

(

)

[virtual]

Virtual destructor.

Definition at line 38 of file TimeState.C.

---

Member Function Documentation

Foam::scalar userTimeToTime

(

const scalar

theta

)

const [virtual]

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

Reimplemented in engineTime.

Definition at line 44 of file TimeState.C.

Foam::scalar timeToUserTime

(

const scalar

t

)

const [virtual]

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

Reimplemented in engineTime.

Definition at line 50 of file TimeState.C.

Referenced by Time::setEndTime().

Here is the caller graph for this function:

Foam::scalar timeOutputValue

(

)

const [virtual]

Return current time value.

Definition at line 56 of file TimeState.C.

Referenced by Time::findInstance().

Here is the caller graph for this function:

Foam::label timeIndex

(

)

const [virtual]

Return current time index.

Definition at line 62 of file TimeState.C.

Referenced by sampledIsoSurface::expire(), sampledThresholdCellFaces::expire(), and sampledIsoSurfaceCell::expire().

Here is the caller graph for this function:

Foam::dimensionedScalar deltaT

(

)

const [virtual]

Return time step.

Definition at line 68 of file TimeState.C.

Referenced by DsmcCloud< ParcelType >::cachedDeltaT(), spray::evolve(), Foam::MULES::explicitSolve(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerDdtScheme< Type >::fvcDdt(), spray::inject(), and solidParticle::move().

Here is the caller graph for this function:

Foam::dimensionedScalar deltaT0

(

)

const [virtual]

Return old time step.

Definition at line 74 of file TimeState.C.

Referenced by EulerD2dt2Scheme< Type >::fvcD2dt2(), and boundedBackwardDdtScheme::fvcDdt().

Here is the caller graph for this function:

bool outputTime

(

)

const [virtual]

Return true if this is an output time.

Definition at line 80 of file TimeState.C.

---

Member Data Documentation

label timeIndex_ [protected]

Definition at line 52 of file TimeState.H.

Referenced by Time::setEndTime(), Time::setTime(), and Time::Time().

scalar deltaT_ [protected]

Definition at line 53 of file TimeState.H.

Referenced by Time::readDict(), and Time::subCycle().

scalar deltaTSave_ [protected]

Definition at line 54 of file TimeState.H.

scalar deltaT0_ [protected]

Definition at line 55 of file TimeState.H.

bool deltaTchanged_ [protected]

Definition at line 56 of file TimeState.H.

Referenced by Time::readDict(), and Time::subCycle().

label outputTimeIndex_ [protected]

Definition at line 58 of file TimeState.H.

Referenced by Time::readDict().

bool outputTime_ [protected]

Definition at line 59 of file TimeState.H.

Referenced by Time::writeAndEnd().

---

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

• src/OpenFOAM/db/Time/TimeState.H
• src/OpenFOAM/db/Time/TimeState.C