FreeFOAM The Cross-Platform CFD Toolkit
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.
- Public Member Functions inherited from dimensioned< Type >
 dimensioned (const word &, const dimensionSet &, const Type)
 Construct given a name, a value and its dimensionSet.
 dimensioned (const word &, const dimensioned< Type > &)
 Construct from a dimensioned<Type> changing the name.
 dimensioned (const Type &t)
 Construct given a value (creates dimensionless value).
 dimensioned (Istream &)
 Construct from Istream.
 dimensioned (const word &, Istream &)
 Construct from an Istream with a given name.
 dimensioned (const word &, const dimensionSet &, Istream &)
 Construct from an Istream with a given name and dimensions.
const wordname () const
 Return const reference to name.
wordname ()
 Return non-const reference to name.
const dimensionSetdimensions () const
 Return const reference to dimensions.
dimensionSetdimensions ()
 Return non-const reference to dimensions.
const Type & value () const
 Return const reference to value.
Type & value ()
 Return non-const reference to value.
dimensioned< cmptTypecomponent (const direction) const
 Return a component as a dimensioned<cmptType>
void replace (const direction, const dimensioned< cmptType > &)
 Return a component with a dimensioned<cmptType>
dimensioned< Type > T () const
 Return transpose.
bool readIfPresent (const dictionary &)
 Update the value of dimensioned<Type> if found in the dictionary.
dimensioned< cmptTypeoperator[] (const direction) const
 Return a component as a dimensioned<cmptType>
void operator+= (const dimensioned< Type > &)
void operator-= (const dimensioned< Type > &)
void operator*= (const scalar)
void operator/= (const scalar)

Protected Attributes

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

Additional Inherited Members

- Public Types inherited from dimensioned< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type.
- Static Public Member Functions inherited from dimensioned< Type >
static dimensioned< Type > lookupOrDefault (const word &, const dictionary &, const Type &defaultValue=pTraits< Type >::zero, const dimensionSet &dims=dimless)
 Construct from dictionary, with default value.
static dimensioned< Type > lookupOrAddToDict (const word &, dictionary &, const Type &defaultValue=pTraits< Type >::zero, const dimensionSet &dims=dimless)
 Construct from dictionary, with default value.

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.

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: