subCycleField< GeometricField > Class Template Reference

Public Types

typedef GeometricField FieldsType
 Type of the field. More...

Public Member Functions

 subCycleField (GeometricField &gf)
 Construct from field and number of sub-cycles. More...
 ~subCycleField ()
 Destructor. More...
const Timetime () const
 Access to time. More...
void updateTimeIndex ()
 Correct the time index of the field to correspond to. More...

Detailed Description

template<class GeometricField>
class Foam::subCycleField< GeometricField >

Definition at line 46 of file subCycle.H.

Member Typedef Documentation

◆ FieldsType

Type of the field.

Definition at line 65 of file subCycle.H.

Constructor & Destructor Documentation

◆ subCycleField()

subCycleField ( GeometricField gf)

Construct from field and number of sub-cycles.

Definition at line 70 of file subCycle.H.

◆ ~subCycleField()

~subCycleField ( )


Definition at line 79 of file subCycle.H.

References subCycleField< GeometricField >::time(), TimeState::timeIndex(), and GeometricField< Type, PatchField, GeoMesh >::timeIndex().

Here is the call graph for this function:

Member Function Documentation

◆ time()

const Time& time ( ) const

◆ updateTimeIndex()

void updateTimeIndex ( )

Correct the time index of the field to correspond to.

the sub-cycling time.

The time index is incremented to protect the old-time value from being updated at the beginning of the time-loop in the case of outer iteration

Definition at line 101 of file subCycle.H.

Referenced by subCycle< GeometricField, SubCycleField >::subCycle(), subCycleField< GeometricField >::time(), and subCycleFields< GeometricField >::time().

Here is the caller graph for this function:

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