The time value with time-stepping information, user-defined remapping, etc. More...
Public Member Functions | |
TimeState () | |
virtual | ~TimeState () |
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 |
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... | |
bool | outputTime () const |
Return true if this is a write time. More... | |
Public Member Functions inherited from dimensioned< scalar > | |
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... | |
dimensioned () | |
Null constructor. More... | |
const word & | name () const |
Return const reference to name. More... | |
word & | name () |
Return non-const reference to name. More... | |
const dimensionSet & | dimensions () const |
Return const reference to dimensions. More... | |
dimensionSet & | dimensions () |
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< cmptType > | component (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... | |
Istream & | read (Istream &is, const dictionary &) |
Read value from stream and units from dictionary. More... | |
Istream & | read (Istream &is, const HashTable< dimensionedScalar > &) |
Read value from stream and units from table. More... | |
Istream & | read (Istream &is) |
Read value from stream and units from system table. More... | |
bool | readIfPresent (const dictionary &) |
Update the value of dimensioned<Type> if found in the dictionary. More... | |
dimensioned< cmptType > | operator[] (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) |
Protected Attributes | |
label | timeIndex_ |
scalar | deltaT_ |
scalar | deltaTSave_ |
scalar | deltaT0_ |
bool | deltaTchanged_ |
label | writeTimeIndex_ |
bool | writeTime_ |
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... | |
The time value with time-stepping information, user-defined remapping, etc.
Definition at line 48 of file TimeState.H.
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 crankConRod.
Definition at line 52 of file TimeState.C.
Referenced by Polynomial< Type >::convertTimeBase(), and TableBase< Type >::convertTimeBase().
|
virtual |
Convert the real-time (s) into user-time (e.g. CA deg)
Reimplemented in crankConRod.
Definition at line 58 of file TimeState.C.
Referenced by TimeState::timeOutputValue(), and Time::writeTimeDict().
|
inline |
Return current time value.
Definition at line 29 of file TimeStateI.H.
References TimeState::timeToUserTime(), and dimensioned< scalar >::value().
Referenced by dynamicMeshPointInterpolator::curPointField(), edgeMeshFormatsCore::getLineNoComment(), surfaceFormatsCore::getLineNoComment(), and triSurface::triSurfInstance().
|
inline |
Return current time index.
Definition at line 35 of file TimeStateI.H.
References TimeState::timeIndex_.
Referenced by Residuals< Type >::append(), ignitionSite::cells(), layerAdditionRemoval::changeTopology(), convergenceControl::converged(), radiationModel::correct(), CrankNicolsonDdtScheme< Type >::ddt0_(), waveVelocityFvPatchVectorField::faceCellSubset(), fvMesh::movePoints(), polyMesh::movePoints(), isoSurface::needsUpdate(), sampledSurfaces::thresholdCellFaces::needsUpdate(), fvMesh::phi(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), cloudSolution::solveThisStep(), subCycleField< GeometricField >::time(), subCycleFields< GeometricField >::time(), subCycleField< GeometricField >::~subCycleField(), and subCycleFields< GeometricField >::~subCycleFields().
|
inline |
Return time step value.
Definition at line 41 of file TimeStateI.H.
References TimeState::deltaT_.
Referenced by cellCoBlended< Type >::blendingFactor(), fieldAverage::calculateMeanFieldType(), fieldAverage::calculatePrime2MeanFieldType(), cloudSolution::canEvolve(), Foam::MULES::correct(), solidification::correctModel(), kinematicSingleLayer::CourantNumber(), engineValve::curVelocity(), Foam::MULES::explicitSolve(), ignitionSite::ignited(), ignitionSite::igniting(), phaseChangeModel::info(), Foam::MULES::limit(), layeredEngineMesh::move(), fvMotionSolverEngineMesh::move(), solidParticleCloud::move(), fvMesh::movePoints(), VoidFraction< CloudType >::postEvolve(), thermoSingleLayer::Sh(), reactingOneDim::solidRegionDiffNo(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), thermoSingleLayer::Srho(), particle< Type >::stepFractionSpan(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), movingWallVelocityFvPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), surfaceDisplacementPointPatchVectorField::updateCoeffs(), plenumPressureFvPatchScalarField::updateCoeffs(), thermoSingleLayer::updateSubmodels(), fvMesh::Vsc(), and fvMesh::Vsc0().
|
inline |
Return old time step value.
Definition at line 47 of file TimeStateI.H.
References TimeState::deltaT0_.
Referenced by sixDoFRigidBodyMotionSolver::solve().
|
inline |
Return time step.
Definition at line 53 of file TimeStateI.H.
References TimeState::deltaT_, and Foam::dimTime.
Referenced by CoBlended< Type >::blendingFactor(), reactingOneDim::calculateMassTransfer(), CrankNicolsonDdtScheme< Type >::ddt0_(), kinematicSingleLayer::deltaMass(), continuousGasKEqn< BasicTurbulenceModel >::phaseTransferCoeff(), continuousGasKEpsilon< BasicTurbulenceModel >::phaseTransferCoeff(), NicenoKEqn< BasicTurbulenceModel >::phaseTransferCoeff(), LaheyKEpsilon< BasicTurbulenceModel >::phaseTransferCoeff(), movingConeTopoFvMesh::update(), and kinematicSingleLayer::updateSubmodels().
|
inline |
Return old time step.
Definition at line 59 of file TimeStateI.H.
References TimeState::deltaT0_, and Foam::dimTime.
Referenced by CrankNicolsonDdtScheme< Type >::ddt0_().
|
inline |
Return true if this is a write time.
Definition at line 65 of file TimeStateI.H.
References TimeState::writeTime_.
Referenced by curvatureSeparation::calcCosAngle(), curvatureSeparation::calcInvR1(), contactAngleForce::correct(), thixotropicViscosity::correct(), convergenceControl::endIfConverged(), cloudSolution::output(), writeObjectsBase::write(), Time::writeObject(), and filmSubModelBase::writeTime().
|
inline |
Return true if this is a write time.
Provided for backward-compatibility
Definition at line 71 of file TimeStateI.H.
References TimeState::writeTime_.
|
protected |
Definition at line 55 of file TimeState.H.
Referenced by Time::setTime(), TimeState::timeIndex(), and Time::writeTimeDict().
|
protected |
Definition at line 56 of file TimeState.H.
Referenced by TimeState::deltaT(), TimeState::deltaTValue(), Time::readDict(), and Time::writeTimeDict().
|
protected |
Definition at line 57 of file TimeState.H.
|
protected |
Definition at line 58 of file TimeState.H.
Referenced by TimeState::deltaT0(), TimeState::deltaT0Value(), and Time::writeTimeDict().
|
protected |
Definition at line 59 of file TimeState.H.
Referenced by Time::readDict().
|
protected |
Definition at line 60 of file TimeState.H.
Referenced by Time::readDict().
|
protected |
Definition at line 61 of file TimeState.H.
Referenced by TimeState::outputTime(), Time::writeNow(), Time::writeObject(), and TimeState::writeTime().