The time value with time-stepping information, user-defined remapping, etc. More...
#include <OpenFOAM/TimeState.H>
The time value with time-stepping information, user-defined remapping, etc.
Definition at line 50 of file TimeState.H.
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. | |
![]() | |
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 word & | name () const |
Return const reference to name. | |
word & | name () |
Return non-const reference to name. | |
const dimensionSet & | dimensions () const |
Return const reference to dimensions. | |
dimensionSet & | dimensions () |
Return non-const reference to dimensions. | |
const Type & | value () const |
Return const reference to value. | |
Type & | value () |
Return non-const reference to value. | |
dimensioned< cmptType > | component (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< cmptType > | operator[] (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 | |
![]() | |
typedef pTraits< Type >::cmptType | cmptType |
Component 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. |
TimeState | ( | ) |
Definition at line 31 of file TimeState.C.
|
virtual |
Destructor.
Definition at line 46 of file TimeState.C.
|
virtual |
Convert the user-time (e.g. CA deg) to real-time (s).
Reimplemented in engineTime.
Definition at line 52 of file TimeState.C.
Referenced by commonRailInjector::commonRailInjector(), definedHollowConeInjector::definedHollowConeInjector(), definedInjector::definedInjector(), multiHoleInjector::multiHoleInjector(), swirlInjector::swirlInjector(), and unitInjector::unitInjector().
|
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().
Foam::label timeIndex | ( | ) | const |
Return current time index.
Definition at line 70 of file TimeState.C.
Referenced by ignitionSite::cells(), sampledThresholdCellFaces::needsUpdate(), sampledIsoSurfaceCell::needsUpdate(), sampledIsoSurface::needsUpdate(), fvMesh::phi(), and subCycle< GeometricField >::~subCycle().
|
inline |
Return time step value.
Definition at line 95 of file TimeState.H.
References TimeState::deltaT_.
Referenced by KinematicCloud< ParcelType >::checkParcelProperties(), DsmcParcel< ParcelType >::move(), KinematicParcel< ParcelType >::move(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), fvMesh::Vsc(), and fvMesh::Vsc0().
|
inline |
Return old time step value.
Definition at line 101 of file TimeState.H.
References TimeState::deltaT0_.
Referenced by uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().
Foam::dimensionedScalar deltaT | ( | ) | const |
Return time step.
Definition at line 76 of file TimeState.C.
References Foam::dimTime.
Referenced by spray::atomizationLoop(), spray::breakupLoop(), fieldAverage::calculateMeanFields(), fieldAverage::calculatePrime2MeanFields(), gradientDispersionRAS::disperseParcels(), stochasticDispersionRAS::disperseParcels(), spray::evaporationSource(), spray::evolve(), Foam::MULES::explicitSolve(), spray::heatTransferSource(), ignitionSite::ignited(), ignitionSite::igniting(), Foam::MULES::implicitSolve(), spray::inject(), Foam::MULES::limiter(), spray::momentumSource(), layeredEngineMesh::move(), fvMotionSolverEngineMesh::move(), trackedParticle::move(), solidParticle::move(), molecule::move(), parcel::move(), movingWallVelocityFvPatchVectorField::updateCoeffs(), and surfaceDisplacementPointPatchVectorField::updateCoeffs().
Foam::dimensionedScalar deltaT0 | ( | ) | const |
bool outputTime | ( | ) | const |
Return true if this is an output time.
Definition at line 88 of file TimeState.C.
|
protected |
Definition at line 57 of file TimeState.H.
Referenced by Time::setTime().
|
protected |
Definition at line 58 of file TimeState.H.
Referenced by Time::adjustDeltaT(), TimeState::deltaTValue(), and Time::readDict().
|
protected |
Definition at line 59 of file TimeState.H.
|
protected |
Definition at line 60 of file TimeState.H.
Referenced by TimeState::deltaT0Value().
|
protected |
Definition at line 61 of file TimeState.H.
Referenced by Time::readDict().
|
protected |
Definition at line 63 of file TimeState.H.
Referenced by Time::adjustDeltaT(), and Time::readDict().
|
protected |
Definition at line 64 of file TimeState.H.