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

Inheritance diagram for TimeState:

Collaboration diagram for TimeState:

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...

Public Member Functions inherited from dimensioned< scalar >
	dimensioned ()
	Null constructor. More...

	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 unitConversion &, Istream &)
	Construct from an Istream with a given name and units. More...

	dimensioned (const word &, const dimensionSet &, const dictionary &)
	Construct from dictionary lookup with a given name and dimensions. More...

	dimensioned (const word &, const unitConversion &, const dictionary &)
	Construct from dictionary lookup with a given name and units. More...

	dimensioned (const word &name, const dimensionSet &dimensions, const dictionary &dict, const scalar &defaultValue, const bool writeDefault=dictionary::writeOptionalEntries > 0)
	Construct from dictionary lookup with a given name and dimensions. More...

	dimensioned (const word &name, const dictionary &dict, const scalar &defaultValue, const bool writeDefault=dictionary::writeOptionalEntries > 0)
	Construct from dictionary lookup with the given name, dimensionless,. More...

	dimensioned (const word &name, const unitConversion &, const dictionary &, const scalar &defaultValue, const bool writeDefault=dictionary::writeOptionalEntries > 0)
	Construct from dictionary lookup with the given name and units. 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 &, const unitConversion &defaultUnits=NullObjectRef< unitConversion >())
	Update the value of dimensioned<Type> More...

bool	readIfPresent (const dictionary &, const unitConversion &defaultUnits=NullObjectRef< unitConversion >())
	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...

Detailed Description

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

Source files

Definition at line 52 of file TimeState.H.

Constructor & Destructor Documentation

◆ TimeState()

TimeState ( )

Definition at line 31 of file TimeState.C.

Member Function Documentation

◆ timeIndex()

Foam::label timeIndex ( ) const

inline

Return current time index.

Definition at line 28 of file TimeStateI.H.

Referenced by Residuals< Type >::append(), VoFClouds::correct(), filmVoFTransfer::correct(), VoFFilmTransfer::correct(), EDC::correct(), laminar::correct(), clouds::correct(), CrankNicolsonDdtScheme< Type >::ddt0_(), waveAlphaFvPatchScalarField::faceCellSubset(), waveVelocityFvPatchVectorField::faceCellSubset(), tetIndices::faceTriIs(), functions::functions(), volumeInjection::modify(), isoSurface::needsUpdate(), thresholdCellFaces::needsUpdate(), fvConstraints::read(), fvModels::read(), LagrangianModels::read(), incompressibleFluid::setRDeltaT(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), distributor::update(), loadBalancer::update(), meshToMesh::update(), refiner::update(), sampledIsoSurfaceSurface::update(), subCycleField< GeometricField >::~subCycleField(), and subCycleFields< GeometricField >::~subCycleFields().

Here is the caller graph for this function:

◆ deltaTValue()

Foam::scalar deltaTValue ( ) const

inline

Return time step value.

Definition at line 34 of file TimeStateI.H.

Referenced by Flux< CloudType, Derived >::accumulate(), timeControl::active(), cellCoBlended< Type >::blendingFactor(), filmCloudTransfer::CloudToFilmTransferRate(), filmVoFTransfer::correct(), VoFFilmTransfer::correct(), laminar::correct(), Foam::MULES::correct(), PairSpringSliderDashpot< CloudType >::evaluatePair(), Foam::MULES::explicitSolve(), EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvmD2dt2(), EulerDdtScheme< Type >::fvmDdt(), DSMCParcel< ParcelType >::hitWallPatch(), multiCycleConstantbXiIgnition::ignited(), multiCycleConstantbXiIgnition::igniting(), FreeStream< CloudType >::inflow(), Foam::MULES::limit(), Foam::MULES::limitCorr(), molecule::move(), solidParticle::move(), DSMCParcel< ParcelType >::move(), MomentumCloud< CloudType >::patchData(), cloudFlux::preCrossFaces(), rigidBodyMeshMotion::solve(), rigidBodyMeshMotionSolver::solve(), sixDoFRigidBodyMotionSolver::solve(), LagrangianSubMesh::Uf(), movingWallVelocityFvPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), surfaceDisplacementPointPatchVectorField::updateCoeffs(), Function1LagrangianFieldSource< Type >::value(), fvMesh::Vsc(), and fvMesh::Vsc0().

Here is the caller graph for this function:

◆ deltaT0Value()

Foam::scalar deltaT0Value ( ) const

inline

Return old time step value.

Definition at line 40 of file TimeStateI.H.

Referenced by EulerD2dt2Scheme< Type >::fvcD2dt2(), EulerD2dt2Scheme< Type >::fvmD2dt2(), and sixDoFRigidBodyMotionSolver::solve().

Here is the caller graph for this function:

◆ deltaT()

Foam::dimensionedScalar deltaT ( ) const

inline

Return time step.

Definition at line 46 of file TimeStateI.H.

References Foam::dimTime.

Here is the caller graph for this function:

◆ deltaT0()

Foam::dimensionedScalar deltaT0 ( ) const

inline

Return old time step.

Definition at line 52 of file TimeStateI.H.

References Foam::dimTime.

◆ writeTime()

bool writeTime ( ) const

inline

Return true if this is a write time.

Definition at line 58 of file TimeStateI.H.

Referenced by convergenceControl::endIfConverged().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Time

friend class Time

friend

Declare friendship with the Time class.

Definition at line 70 of file TimeState.H.

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

src/OpenFOAM/db/Time/TimeState.H
src/OpenFOAM/db/Time/TimeState.C
src/OpenFOAM/db/Time/TimeStateI.H

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TimeState()

Member Function Documentation

◆ timeIndex()

◆ deltaTValue()

◆ deltaT0Value()

◆ deltaT()

◆ deltaT0()

◆ writeTime()

Friends And Related Function Documentation

◆ Time