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]

Public Member Functions

 TimeState ()
 Construct a zero time state, using the current time formatting. More...
 
virtual ~TimeState ()=default
 Destructor. More...
 
virtual scalar userTimeToTime (const scalar theta) const
 Convert the user-time (e.g. CA deg) to real-time (s). More...
 
virtual scalar timeToUserTime (const scalar t) const
 Convert the real-time (s) into user-time (e.g. CA deg) More...
 
scalar timeOutputValue () const
 Return current time value. More...
 
label timeIndex () const noexcept
 Return current time index. More...
 
scalar deltaTValue () const noexcept
 Return time step value. More...
 
scalar deltaT0Value () const noexcept
 Return old time step value. More...
 
dimensionedScalar deltaT () const
 Return time step. More...
 
dimensionedScalar deltaT0 () const
 Return old time step. More...
 
bool writeTime () const noexcept
 True if this is a write time. More...
 
bool outputTime () const noexcept
 Deprecated(2016-05) return true if this is a write time. More...
 
- Public Member Functions inherited from dimensioned< Type >
 dimensioned ()
 A dimensionless Zero, named "0". More...
 
 dimensioned (const dimensionSet &dims)
 A dimensioned Zero, named "0". More...
 
 dimensioned (const dimensionSet &dims, const Foam::zero)
 A dimensioned Zero, named "0". More...
 
 dimensioned (const dimensionSet &dims, const Foam::one)
 A dimensioned pTraits::one, named "1". More...
 
 dimensioned (const Type &val)
 Implicit construct dimensionless from given value. More...
 
 dimensioned (const dimensionSet &dims, const Type &val)
 Construct dimensioned from given value. More...
 
 dimensioned (const word &name, const dimensionSet &dims, const Type &val)
 Construct from components (name, dimensions, value). More...
 
 dimensioned (const word &name, const dimensioned< Type > &dt)
 Copy construct dimensioned Type with a new name. More...
 
 dimensioned (const primitiveEntry &e)
 Construct from primitive entry with given name. More...
 
 dimensioned (const primitiveEntry &e, const dimensionSet &dims)
 Construct from primitive entry with given name and dimensions. More...
 
 dimensioned (const word &name, const dictionary &dict)
 Construct from dictionary lookup with a given name. More...
 
 dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict)
 Construct from dictionary lookup with a given name and dimensions. More...
 
 dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName)
 Construct from dictionary lookup with a given name and dimensions. More...
 
 dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict)
 
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 Type & value () const
 Return const reference to value. More...
 
Type & value ()
 Return non-const reference to value. More...
 
dimensioned< cmptTypecomponent (const direction d) const
 Return a component as a dimensioned<cmptType> More...
 
void replace (const direction d, const dimensioned< cmptType > &dc)
 Return a component with a dimensioned<cmptType> More...
 
dimensioned< Type > T () const
 Return transpose. More...
 
bool read (const dictionary &dict)
 
bool readIfPresent (const dictionary &dict)
 
bool read (const word &entryName, const dictionary &dict)
 
bool readIfPresent (const word &entryName, const dictionary &dict)
 
Istreamread (Istream &is, const bool readName=true)
 
Istreamread (Istream &is, const dictionary &readSet)
 
Istreamread (Istream &is, const HashTable< dimensionedScalar > &readSet)
 
void writeEntry (const word &keyword, Ostream &os) const
 Write as a dictionary entry with keyword. More...
 
dimensioned< cmptTypeoperator[] (const direction d) const
 Return a component as a dimensioned<cmptType> More...
 
void operator+= (const dimensioned< Type > &dt)
 
void operator-= (const dimensioned< Type > &dt)
 
void operator*= (const scalar s)
 
void operator/= (const scalar s)
 
 dimensioned (Istream &is)
 
 dimensioned (const word &name, Istream &is)
 
 dimensioned (const word &name, const dimensionSet &dims, Istream &is)
 

Protected Attributes

label timeIndex_
 
label writeTimeIndex_
 
scalar deltaT_
 
scalar deltaT0_
 
scalar deltaTSave_
 
bool deltaTchanged_
 
bool writeTime_
 

Additional Inherited Members

- Public Types inherited from dimensioned< Type >
typedef Type value_type
 The underlying data type. More...
 
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
- Static Public Member Functions inherited from dimensioned< Type >
static dimensioned< Type > getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 Construct dimensioned from dictionary, with default value. More...
 
static dimensioned< Type > getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
 Construct dimensionless from dictionary, with default value. More...
 
static dimensioned< Type > getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 Construct dimensioned from dictionary, with default value. More...
 
static dimensioned< Type > getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
 Construct dimensionless from dictionary, with default value. More...
 
static dimensioned< Type > lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 
static dimensioned< Type > lookupOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
 Construct dimensionless from dictionary, with default value. More...
 
static dimensioned< Type > lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 Construct dimensioned from dictionary, with default value. More...
 
static dimensioned< Type > lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
 Construct dimensionless from dictionary, with default value. More...
 

Detailed Description

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

Source files

Definition at line 51 of file TimeState.H.

Constructor & Destructor Documentation

◆ TimeState()

TimeState ( )

Construct a zero time state, using the current time formatting.

Definition at line 34 of file TimeState.C.

◆ ~TimeState()

virtual ~TimeState ( )
virtualdefault

Destructor.

Member Function Documentation

◆ userTimeToTime()

Foam::scalar userTimeToTime ( const scalar  theta) const
virtual

◆ timeToUserTime()

Foam::scalar timeToUserTime ( const scalar  t) const
virtual

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

Reimplemented in crankConRod.

Definition at line 55 of file TimeState.C.

Referenced by maxDurationCondition::apply(), and TimeState::timeOutputValue().

Here is the caller graph for this function:

◆ timeOutputValue()

Foam::scalar timeOutputValue ( ) const
inline

Return current time value.

Definition at line 31 of file TimeStateI.H.

References TimeState::timeToUserTime(), and dimensioned< Type >::value().

Referenced by setTimeStepFunctionObject::adjustTimeStep(), atmBoundaryLayer::epsilon(), atmBoundaryLayer::flowDir(), atmBoundaryLayer::k(), atmBoundaryLayer::omega(), linearSpringDamper::restrain(), triSurface::triSurfInstance(), atmBoundaryLayer::U(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), atmBoundaryLayer::Ustar(), and atmBoundaryLayer::zDir().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ timeIndex()

◆ deltaTValue()

Foam::scalar deltaTValue ( ) const
inlinenoexcept

Return time step value.

Definition at line 43 of file TimeStateI.H.

Referenced by setTimeStepFaRegionsFunctionObject::adjustTimeStep(), timeControl::adjustTimeStep(), minTimeStepCondition::apply(), averageCondition::apply(), cellCoBlended< Type >::blendingFactor(), fieldAverageItem::calculateMeanField(), fieldAverageItem::calculatePrime2MeanField(), SIMPLEControlSingleRun::checkEndTime(), kinematicSingleLayer::CourantNumber(), fieldAverageItem::evolve(), DSMCParcel< ParcelType >::hitWallPatch(), phaseChangeModel::info(), SIMPLEControlOpt::loop(), solidParticleCloud::move(), liquidFilmModel::preEvolveRegion(), SIMPLEControlOpt::resetDeltaT(), thermoSingleLayer::Sh(), reactingOneDim::solidRegionDiffNo(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), thermoSingleLayer::Srho(), particle< Type >::stepFractionSpan(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), surfaceDisplacementPointPatchVectorField::updateCoeffs(), humidityTemperatureCoupledMixedFvPatchScalarField::updateCoeffs(), thermoSingleLayer::updateSubmodels(), fvMesh::Vsc(), and fvMesh::Vsc0().

Here is the caller graph for this function:

◆ deltaT0Value()

Foam::scalar deltaT0Value ( ) const
inlinenoexcept

Return old time step value.

Definition at line 49 of file TimeStateI.H.

Referenced by sixDoFRigidBodyMotionSolver::solve(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ deltaT()

Foam::dimensionedScalar deltaT ( ) const
inline

Return time step.

Definition at line 55 of file TimeStateI.H.

References Foam::dimTime.

Referenced by CoBlended< Type >::blendingFactor(), reactingOneDim::calculateMassTransfer(), liquidFilmBase::CourantNumber(), kinematicSingleLayer::deltaMass(), isoAdvection::getRhoPhi(), multiphaseSystem::solve(), reactingOneDim::solveContinuity(), interfaceTrackingFvMesh::update(), and kinematicSingleLayer::updateSubmodels().

Here is the caller graph for this function:

◆ deltaT0()

Foam::dimensionedScalar deltaT0 ( ) const
inline

Return old time step.

Definition at line 61 of file TimeStateI.H.

References Foam::dimTime.

◆ writeTime()

bool writeTime ( ) const
inlinenoexcept

True if this is a write time.

Definition at line 67 of file TimeStateI.H.

Referenced by curvatureSeparation::calcCosAngle(), DarcyForchheimer::calcTransformModelData(), contactAngleForce::correct(), curvatureSeparation::correct(), incompressiblePrimalSolver::write(), incompressibleAdjointSolver::write(), SIMPLEControlSingleRun::writeNow(), and filmSubModelBase::writeTime().

Here is the caller graph for this function:

◆ outputTime()

bool outputTime ( ) const
inlinenoexcept

Deprecated(2016-05) return true if this is a write time.

Deprecated:
(2016-05) - use writeTime() method

Definition at line 116 of file TimeState.H.

Member Data Documentation

◆ timeIndex_

label timeIndex_
protected

Definition at line 57 of file TimeState.H.

Referenced by Time::setTime().

◆ writeTimeIndex_

label writeTimeIndex_
protected

Definition at line 58 of file TimeState.H.

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

◆ deltaT_

scalar deltaT_
protected

Definition at line 60 of file TimeState.H.

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

◆ deltaT0_

scalar deltaT0_
protected

Definition at line 61 of file TimeState.H.

◆ deltaTSave_

scalar deltaTSave_
protected

Definition at line 62 of file TimeState.H.

◆ deltaTchanged_

bool deltaTchanged_
protected

Definition at line 64 of file TimeState.H.

Referenced by Time::readDict().

◆ writeTime_

bool writeTime_
protected

Definition at line 65 of file TimeState.H.


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