Public Member Functions | Protected Attributes | List of all members
TimeState Class Reference

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

Inheritance diagram for TimeState:
Inheritance graph
[legend]
Collaboration diagram for TimeState:
Collaboration graph
[legend]

Public Member Functions

 TimeState ()
 
virtual ~TimeState ()=default
 
virtual scalar userTimeToTime (const scalar theta) const
 
virtual scalar timeToUserTime (const scalar t) const
 
scalar timeOutputValue () const
 
label timeIndex () const noexcept
 
scalar deltaTValue () const noexcept
 
scalar deltaT0Value () const noexcept
 
dimensionedScalar deltaT () const
 
dimensionedScalar deltaT0 () const
 
bool writeTime () const noexcept
 
bool outputTime () const noexcept
 
- Public Member Functions inherited from dimensioned
 dimensioned ()
 
 dimensioned (const dimensionSet &dims)
 
 dimensioned (const dimensionSet &dims, const Foam::zero)
 
 dimensioned (const dimensionSet &dims, const Foam::one)
 
 dimensioned (const Type &val)
 
 dimensioned (const dimensionSet &dims, const Type &val)
 
 dimensioned (const word &name, const dimensionSet &dims, const Type &val)
 
 dimensioned (const word &name, const dimensioned< Type > &dt)
 
 dimensioned (const primitiveEntry &e)
 
 dimensioned (const primitiveEntry &e, const dimensionSet &dims)
 
 dimensioned (const word &name, const dictionary &dict)
 
 dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict)
 
 dimensioned (const word &name, const dimensionSet &dims, const dictionary &dict, const word &entryName)
 
 dimensioned (const word &name, const dimensionSet &dims, const Type &val, const dictionary &dict)
 
const word & name () const
 
word & name ()
 
const dimensionSet & dimensions () const
 
dimensionSet & dimensions ()
 
const Type & value () const
 
Type & value ()
 
dimensioned< cmptType > component (const direction d) const
 
void replace (const direction d, const dimensioned< cmptType > &dc)
 
dimensioned< Type > T () const
 
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)
 
Istream & read (Istream &is, const bool readName=true)
 
Istream & read (Istream &is, const dictionary &readSet)
 
Istream & read (Istream &is, const HashTable< dimensionedScalar > &readSet)
 
void writeEntry (const word &keyword, Ostream &os) const
 
dimensioned< cmptType > operator[] (const direction d) const
 
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
typedef Type value_type
 
typedef pTraits< Type >::cmptType cmptType
 
- Static Public Member Functions inherited from dimensioned
static dimensioned< Type > getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 
static dimensioned< Type > getOrDefault (const word &name, const dictionary &dict, const Type &deflt=Type(Zero))
 
static dimensioned< Type > getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 
static dimensioned< Type > getOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
 
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))
 
static dimensioned< Type > lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const Type &deflt=Type(Zero))
 
static dimensioned< Type > lookupOrAddToDict (const word &name, dictionary &dict, const Type &deflt=Type(Zero))
 

Detailed Description

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

Source files

Definition at line 47 of file TimeState.H.

Constructor & Destructor Documentation

◆ TimeState()

TimeState ( )

Definition at line 27 of file TimeState.C.

◆ ~TimeState()

virtual ~TimeState ( )
virtualdefault

Member Function Documentation

◆ userTimeToTime()

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

Reimplemented in crankConRod.

Definition at line 42 of file TimeState.C.

Referenced by ConeInjection< CloudType >::ConeInjection(), ConeNozzleInjection< CloudType >::ConeNozzleInjection(), equationInitialResidualCondition::equationInitialResidualCondition(), InflationInjection< CloudType >::InflationInjection(), PatchFlowRateInjection< CloudType >::PatchFlowRateInjection(), PatchInjection< CloudType >::PatchInjection(), TableBase< Type >::userTimeToTime(), Polynomial< Type >::userTimeToTime(), ramp::userTimeToTime(), and Sine< Type >::userTimeToTime().

Here is the caller graph for this function:

◆ timeToUserTime()

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

Reimplemented in crankConRod.

Definition at line 48 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

Definition at line 24 of file TimeStateI.H.

References TimeState::timeToUserTime(), and dimensioned::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()

Foam::label timeIndex ( ) const
inlinenoexcept

Definition at line 30 of file TimeStateI.H.

Referenced by setTimeStepFaRegionsFunctionObject::adjustTimeStep(), setTimeStepFunctionObject::adjustTimeStep(), equationMaxIterCondition::apply(), layerAdditionRemoval::changeTopology(), sampledInterface::needsUpdate(), sampledThresholdCellFaces::needsUpdate(), sampledIsoSurface::needsUpdate(), exprResultGlobals::New(), optionList::readOptions(), multiphaseSystem::solve(), interfaceTrackingFvMesh::update(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and velocityFilmShellFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ deltaTValue()

Foam::scalar deltaTValue ( ) const
inlinenoexcept

Definition at line 36 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::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

Definition at line 42 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

Definition at line 48 of file TimeStateI.H.

References Foam::dimTime.

Referenced by objective::accumulateJMean(), 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

Definition at line 54 of file TimeStateI.H.

References Foam::dimTime.

◆ writeTime()

bool writeTime ( ) const
inlinenoexcept

Definition at line 60 of file TimeStateI.H.

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

Here is the caller graph for this function:

◆ outputTime()

bool outputTime ( ) const
inlinenoexcept

Definition at line 112 of file TimeState.H.

References TimeState::writeTime().

Here is the call graph for this function:

Member Data Documentation

◆ timeIndex_

label timeIndex_
protected

Definition at line 53 of file TimeState.H.

Referenced by Time::setTime().

◆ writeTimeIndex_

label writeTimeIndex_
protected

Definition at line 54 of file TimeState.H.

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

◆ deltaT_

scalar deltaT_
protected

Definition at line 56 of file TimeState.H.

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

◆ deltaT0_

scalar deltaT0_
protected

Definition at line 57 of file TimeState.H.

◆ deltaTSave_

scalar deltaTSave_
protected

Definition at line 58 of file TimeState.H.

◆ deltaTchanged_

bool deltaTchanged_
protected

Definition at line 60 of file TimeState.H.

Referenced by Time::readDict().

◆ writeTime_

bool writeTime_
protected

Definition at line 61 of file TimeState.H.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17