FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

TimeState Class Reference

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

#include <OpenFOAM/TimeState.H>


Detailed Description

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

Source files

Definition at line 50 of file TimeState.H.

Inheritance diagram for TimeState:
Collaboration diagram for TimeState:

List of all members.

Public Member Functions

 TimeState ()
virtual  ~TimeState ()
 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)
scalar  timeOutputValue () const
 Return current time value.
label  timeIndex () const
 Return current time index.
scalar  deltaTValue () const
 Return time step value.
scalar  deltaT0Value () const
 Return old time step value.
dimensionedScalar  deltaT () const
 Return time step.
dimensionedScalar  deltaT0 () const
 Return old time step.
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 (  )

Definition at line 31 of file TimeState.C.

~TimeState (  ) [virtual]

Destructor.

Definition at line 46 of file TimeState.C.


Member Function Documentation

Foam::scalar userTimeToTime ( const scalar   theta  ) const [virtual]
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 58 of file TimeState.C.

Foam::scalar timeOutputValue (  ) const

Return current time value.

Definition at line 64 of file TimeState.C.

Referenced by triSurface::triSurfInstance().

scalar deltaT0Value (  ) const [inline]
Foam::dimensionedScalar deltaT0 (  ) const

Return old time step.

Definition at line 82 of file TimeState.C.

References Foam::dimTime.

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

bool outputTime (  ) const

Return true if this is an output time.

Definition at line 88 of file TimeState.C.


Member Data Documentation

label timeIndex_ [protected]

Definition at line 57 of file TimeState.H.

Referenced by Time::setTime().

scalar deltaT_ [protected]

Definition at line 58 of file TimeState.H.

Referenced by Time::adjustDeltaT(), TimeState::deltaTValue(), and Time::readDict().

scalar deltaTSave_ [protected]

Definition at line 59 of file TimeState.H.

scalar deltaT0_ [protected]

Definition at line 60 of file TimeState.H.

Referenced by TimeState::deltaT0Value().

bool deltaTchanged_ [protected]

Definition at line 61 of file TimeState.H.

Referenced by Time::readDict().

label outputTimeIndex_ [protected]

Definition at line 63 of file TimeState.H.

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

bool outputTime_ [protected]

Definition at line 64 of file TimeState.H.


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