Public Types | Public Member Functions | List of all members
subCycleField< GeometricField > Class Template Reference

Public Types

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

Public Member Functions

 subCycleField (GeometricField &gf, const label nSubCycles)
 Construct from field and number of sub-cycles. More...
 
 ~subCycleField ()
 Destructor. More...
 
const Time & time () 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

typedef GeometricField FieldsType

Type of the field.

Definition at line 65 of file subCycle.H.

Constructor & Destructor Documentation

◆ subCycleField()

subCycleField ( GeometricField &  gf,
const label  nSubCycles 
)
inline

Construct from field and number of sub-cycles.

Definition at line 71 of file subCycle.H.

References IOobject::name(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ ~subCycleField()

~subCycleField ( )
inline

Destructor.

Definition at line 87 of file subCycle.H.

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

Here is the call graph for this function:

Member Function Documentation

◆ time()

const Time& time ( ) const
inline

Access to time.

Definition at line 102 of file subCycle.H.

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

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ 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 113 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: