The time value with time-stepping information, user-defined remapping, etc. More...
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 |
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 |
Deprecated(2016-05) return true if this is a write time. More... | |
Public Member Functions inherited from dimensioned< scalar > | |
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 scalar &val) | |
Implicit construct dimensionless from given value. More... | |
dimensioned (const dimensionSet &dims, const scalar &val) | |
Construct dimensioned from given value. More... | |
dimensioned (const word &name, const dimensionSet &dims, const scalar &val) | |
Construct from components (name, dimensions, value). More... | |
dimensioned (const word &name, const dimensioned< scalar > &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 scalar &val, const dictionary &dict) | |
dimensioned (Istream &is) | |
dimensioned (const word &name, Istream &is) | |
dimensioned (const word &name, const dimensionSet &dims, Istream &is) | |
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 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< scalar > | T () const |
Return transpose. More... | |
bool | read (const dictionary &dict) |
bool | read (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) |
bool | readIfPresent (const dictionary &dict) |
bool | readIfPresent (const word &entryName, const dictionary &dict) |
void | writeEntry (const word &keyword, Ostream &os) const |
Write as a dictionary entry with keyword. More... | |
dimensioned< cmptType > | operator[] (const direction d) const |
Return a component as a dimensioned<cmptType> More... | |
void | operator+= (const dimensioned< scalar > &dt) |
void | operator-= (const dimensioned< scalar > &dt) |
void | operator*= (const scalar s) |
void | operator/= (const scalar s) |
Protected Attributes | |
label | timeIndex_ |
label | writeTimeIndex_ |
scalar | deltaT_ |
scalar | deltaT0_ |
scalar | deltaTSave_ |
bool | deltaTchanged_ |
bool | writeTime_ |
Additional Inherited Members | |
Public Types inherited from dimensioned< scalar > | |
typedef scalar | value_type |
The underlying data type. More... | |
typedef pTraits< scalar >::cmptType | cmptType |
Component type. More... | |
Static Public Member Functions inherited from dimensioned< scalar > | |
static dimensioned< scalar > | getOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
Construct dimensioned from dictionary, with default value. More... | |
static dimensioned< scalar > | getOrDefault (const word &name, const dictionary &dict, const scalar &deflt=scalar(Zero)) |
Construct dimensionless from dictionary, with default value. More... | |
static dimensioned< scalar > | getOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
Construct dimensioned from dictionary, with default value. More... | |
static dimensioned< scalar > | getOrAddToDict (const word &name, dictionary &dict, const scalar &deflt=scalar(Zero)) |
Construct dimensionless from dictionary, with default value. More... | |
static dimensioned< scalar > | lookupOrDefault (const word &name, const dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
static dimensioned< scalar > | lookupOrDefault (const word &name, const dictionary &dict, const scalar &deflt=scalar(Zero)) |
Construct dimensionless from dictionary, with default value. More... | |
static dimensioned< scalar > | lookupOrAddToDict (const word &name, dictionary &dict, const dimensionSet &dims=dimless, const scalar &deflt=scalar(Zero)) |
Construct dimensioned from dictionary, with default value. More... | |
static dimensioned< scalar > | lookupOrAddToDict (const word &name, dictionary &dict, const scalar &deflt=scalar(Zero)) |
Construct dimensionless from dictionary, with default value. More... | |
The time value with time-stepping information, user-defined remapping, etc.
Definition at line 51 of file TimeState.H.
TimeState | ( | ) |
Construct a zero time state, using the current time formatting.
Definition at line 34 of file TimeState.C.
|
virtualdefault |
Destructor.
|
virtual |
Convert the user-time (e.g. CA deg) to real-time (s).
Reimplemented in crankConRod.
Definition at line 49 of file TimeState.C.
Referenced by Polynomial< Type >::convertTimeBase(), TableBase< Type >::convertTimeBase(), and equationInitialResidualCondition::equationInitialResidualCondition().
|
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().
|
inline |
Return current time value.
Definition at line 30 of file TimeStateI.H.
References TimeState::timeToUserTime(), and dimensioned< scalar >::value().
Referenced by setTimeStepFunctionObject::adjustTimeStep(), atmBoundaryLayer::epsilon(), atmBoundaryLayer::flowDir(), atmBoundaryLayer::k(), atmBoundaryLayer::omega(), triSurface::triSurfInstance(), atmBoundaryLayer::U(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), atmBoundaryLayer::Ustar(), lumpedPointMovement::writeData(), and atmBoundaryLayer::zDir().
|
inline |
Return current time index.
Definition at line 36 of file TimeStateI.H.
Referenced by setTimeStepFunctionObject::adjustTimeStep(), equationMaxIterCondition::apply(), layerAdditionRemoval::changeTopology(), sampledInterface::needsUpdate(), sampledThresholdCellFaces::needsUpdate(), sampledIsoSurfaceTopo::needsUpdate(), sampledIsoSurfaceCell::needsUpdate(), sampledIsoSurface::needsUpdate(), exprResultGlobals::New(), optionAdjointList::readOptionAdjoints(), optionList::readOptions(), interfaceTrackingFvMesh::update(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and lumpedPointMovement::writeData().
|
inline |
Return time step value.
Definition at line 42 of file TimeStateI.H.
Referenced by 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(), 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().
|
inline |
Return old time step value.
Definition at line 48 of file TimeStateI.H.
Referenced by sixDoFRigidBodyMotionSolver::solve(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs(), and sixDoFRigidBodyDisplacementPointPatchVectorField::updateCoeffs().
|
inline |
Return time step.
Definition at line 54 of file TimeStateI.H.
References Foam::dimTime.
Referenced by CoBlended< Type >::blendingFactor(), reactingOneDim::calculateMassTransfer(), kinematicSingleLayer::deltaMass(), isoAdvection::getRhoPhi(), reactingOneDim::solveContinuity(), drivenLinearMotion::transformation(), interfaceTrackingFvMesh::update(), and kinematicSingleLayer::updateSubmodels().
|
inline |
|
inline |
Return true if this is a write time.
Definition at line 66 of file TimeStateI.H.
Referenced by DarcyForchheimer::calcTransformModelData(), contactAngleForce::correct(), incompressiblePrimalSolver::write(), incompressibleAdjointSolver::write(), SIMPLEControlSingleRun::writeNow(), and filmSubModelBase::writeTime().
|
inline |
Deprecated(2016-05) return true if this is a write time.
Definition at line 116 of file TimeState.H.
|
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(), and Time::readDict().
|
protected |
Definition at line 60 of file TimeState.H.
Referenced by Time::adjustDeltaT(), and Time::readDict().
|
protected |
Definition at line 61 of file TimeState.H.
|
protected |
Definition at line 62 of file TimeState.H.
|
protected |
Definition at line 64 of file TimeState.H.
Referenced by Time::readDict().
|
protected |
Definition at line 65 of file TimeState.H.