Public Member Functions | List of all members
subCycleField< GeometricField > Class Template Reference
Inheritance diagram for subCycleField< GeometricField >:
[legend]

Public Member Functions

 subCycleField (GeometricField &gf)
 Construct field and number of sub-cycles. More...
 
 ~subCycleField ()
 Destructor. 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 48 of file subCycle.H.

Constructor & Destructor Documentation

◆ subCycleField()

subCycleField ( GeometricField &  gf)
inline

Construct field and number of sub-cycles.

Definition at line 74 of file subCycle.H.

References IOobject::name(), and Time::New().

Here is the call graph for this function:

◆ ~subCycleField()

~subCycleField ( )
inline

Destructor.

Definition at line 88 of file subCycle.H.

References IOobject::time(), GeometricField< Type, PatchField, GeoMesh >::timeIndex(), TimeState::timeIndex(), and tmp< T >::valid().

Here is the call graph for this function:

Member Function Documentation

◆ updateTimeIndex()

void updateTimeIndex ( )
inline

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 109 of file subCycle.H.

Referenced by subCycle< GeometricField >::subCycle().

Here is the caller graph for this function:
The documentation for this class was generated from the following file: