The time value with time-stepping information, user-defined remapping, etc. More...
Public Member Functions | |
| TimeState () | |
| 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) |
Friends | |
| class | Time |
| Declare friendship with the Time class. More... | |
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 52 of file TimeState.H.
| TimeState | ( | ) |
Definition at line 31 of file TimeState.C.
|
inline |
Return current time index.
Definition at line 28 of file TimeStateI.H.
Referenced by Residuals< Type >::append(), layerAdditionRemoval::changeTopology(), convergenceControl::converged(), radiationModel::correct(), CrankNicolsonDdtScheme< Type >::ddt0_(), waveVelocityFvPatchVectorField::faceCellSubset(), waveAlphaFvPatchScalarField::faceCellSubset(), tetIndices::faceTriIs(), polyMesh::movePoints(), isoSurface::needsUpdate(), thresholdCellFaces::needsUpdate(), fvMesh::phi(), specieTransferMassFractionFvPatchScalarField::phiYp(), fvConstraints::read(), fvModels::read(), polyMesh::setPoints(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), cloudSolution::solveThisStep(), distributionContactAngleForce::theta(), subCycleField< GeometricField >::time(), subCycleFields< GeometricField >::time(), loadBalancer::update(), distributor::update(), refiner::update(), subCycleField< GeometricField >::~subCycleField(), and subCycleFields< GeometricField >::~subCycleFields().
|
inline |
Return time step value.
Definition at line 34 of file TimeStateI.H.
Referenced by cellCoBlended< Type >::blendingFactor(), fieldAverage::calculateMeanFieldType(), fieldAverage::calculatePrime2MeanFieldType(), cloudSolution::canEvolve(), Foam::MULES::correct(), solidification::correctModel(), kinematicSingleLayer::CourantNumber(), Foam::MULES::explicitSolve(), phaseChangeModel::info(), Foam::MULES::limit(), kinematicSingleLayer::maxDeltaT(), VoidFraction< CloudType >::postEvolve(), thermoSingleLayer::Sh(), sixDoFRigidBodyMotionSolver::solve(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), kinematicSingleLayer::Srho(), particle::stepFractionSpan(), kinematicSingleLayer::SU(), thermoSingleLayer::SYi(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), layeredEngine::update(), 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 40 of file TimeStateI.H.
Referenced by sixDoFRigidBodyMotionSolver::solve().
|
inline |
Return time step.
Definition at line 46 of file TimeStateI.H.
References Foam::dimTime.
Referenced by CoBlended< Type >::blendingFactor(), kinematicSingleLayer::continuityCheck(), CrankNicolsonDdtScheme< Type >::ddt0_(), kinematicSingleLayer::deltaMass(), Foam::min(), continuousGasKEqn< BasicMomentumTransportModel >::phaseTransferCoeff(), continuousGasKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), NicenoKEqn< BasicMomentumTransportModel >::phaseTransferCoeff(), LaheyKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), and laminar::Su().
|
inline |
Return old time step.
Definition at line 52 of file TimeStateI.H.
References Foam::dimTime.
Referenced by CrankNicolsonDdtScheme< Type >::ddt0_().
|
inline |
Return true if this is a write time.
Definition at line 58 of file TimeStateI.H.
Referenced by curvatureSeparation::calcCosAngle(), curvatureSeparation::calcInvR1(), contactAngleForce::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 64 of file TimeStateI.H.
|
friend |
Declare friendship with the Time class.
Definition at line 70 of file TimeState.H.
1.8.13 
