TimeState Class Reference

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

Inheritance diagram for TimeState:
Collaboration diagram for TimeState:

Public Member Functions

 TimeState ()
 
label timeIndex () const
 Return current time index. More...
 
scalar deltaTValue () const
 Return time step value. More...
 
scalar deltaT0Value () const
 Return old time step value. More...
 
dimensionedScalar deltaT () const
 Return time step. More...
 
dimensionedScalar deltaT0 () const
 Return old time step. More...
 
bool writeTime () const
 Return true if this is a write time. More...
 
- Public Member Functions inherited from dimensioned< scalar >
 dimensioned ()
 Null constructor. More...
 
 dimensioned (const word &, const dimensionSet &, const scalar &)
 Construct given name, dimensions and value. More...
 
 dimensioned (const dimensionSet &, const scalar &)
 Construct given dimensions and value. More...
 
 dimensioned (const scalar &)
 Construct dimensionless given value only. More...
 
 dimensioned (const word &, const dimensioned< scalar > &)
 Construct from a dimensioned<Type> changing the name. More...
 
 dimensioned (Istream &)
 Construct from Istream. More...
 
 dimensioned (const word &, Istream &)
 Construct from an Istream with a given name. More...
 
 dimensioned (const word &, const dimensionSet &, Istream &)
 Construct from an Istream with a given name and dimensions. More...
 
 dimensioned (const word &, const dimensionSet &, const dictionary &)
 Construct from dictionary lookup with a given name and dimensions. More...
 
const wordname () const
 Return const reference to name. More...
 
wordname ()
 Return non-const reference to name. More...
 
const dimensionSetdimensions () const
 Return const reference to dimensions. More...
 
dimensionSetdimensions ()
 Return non-const reference to dimensions. More...
 
const scalar & value () const
 Return const reference to value. More...
 
scalar & value ()
 Return non-const reference to value. More...
 
dimensioned< cmptTypecomponent (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void replace (const direction, const dimensioned< cmptType > &)
 Return a component with a dimensioned<cmptType> More...
 
dimensioned< scalar > T () const
 Return transpose. More...
 
void read (const dictionary &)
 Update the value of dimensioned<Type> More...
 
bool readIfPresent (const dictionary &)
 Update the value of dimensioned<Type> if found in the dictionary. More...
 
dimensioned< cmptTypeoperator[] (const direction) const
 Return a component as a dimensioned<cmptType> More...
 
void operator+= (const dimensioned< scalar > &)
 
void operator-= (const dimensioned< scalar > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Friends

class Time
 Declare friendship with the Time class. More...
 

Additional Inherited Members

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

Detailed Description

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

Source files

Definition at line 52 of file TimeState.H.

Constructor & Destructor Documentation

◆ TimeState()

TimeState ( )

Definition at line 31 of file TimeState.C.

Member Function Documentation

◆ timeIndex()

◆ deltaTValue()

◆ deltaT0Value()

Foam::scalar deltaT0Value ( ) const
inline

Return old time step value.

Definition at line 40 of file TimeStateI.H.

Referenced by sixDoFRigidBodyMotionSolver::solve().

Here is the caller graph for this function:

◆ deltaT()

Foam::dimensionedScalar deltaT ( ) const
inline

Return time step.

Definition at line 46 of file TimeStateI.H.

References Foam::dimTime.

Referenced by CoBlended< Type >::blendingFactor(), and zeroDimensionalMassSourceBase::correct().

Here is the caller graph for this function:

◆ deltaT0()

Foam::dimensionedScalar deltaT0 ( ) const
inline

Return old time step.

Definition at line 52 of file TimeStateI.H.

References Foam::dimTime.

◆ writeTime()

bool writeTime ( ) const
inline

Return true if this is a write time.

Definition at line 58 of file TimeStateI.H.

Referenced by convergenceControl::endIfConverged().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Time

friend class Time
friend

Declare friendship with the Time class.

Definition at line 70 of file TimeState.H.


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