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

Public Types

typedef UPtrList< GeometricField > FieldsType
 Type of the list of fields. More...
 

Public Member Functions

 subCycleFields (UPtrList< GeometricField > &gfs, const label nSubCycles)
 Construct from field list and number of sub-cycles. More...
 
 ~subCycleFields ()
 Destructor. More...
 
const Time & time () const
 Access to time. More...
 
void updateTimeIndex ()
 Correct the time index of the fields to correspond to. More...
 

Detailed Description

template<class GeometricField>
class Foam::subCycleFields< GeometricField >

Definition at line 126 of file subCycle.H.

Member Typedef Documentation

◆ FieldsType

typedef UPtrList<GeometricField> FieldsType

Type of the list of fields.

Definition at line 145 of file subCycle.H.

Constructor & Destructor Documentation

◆ subCycleFields()

subCycleFields ( UPtrList< GeometricField > &  gfs,
const label  nSubCycles 
)
inline

Construct from field list and number of sub-cycles.

Definition at line 150 of file subCycle.H.

References forAll, Foam::name(), PtrList< T >::set(), UPtrList< T >::set(), PtrList< T >::setSize(), and UPtrList< T >::size().

Here is the call graph for this function:

◆ ~subCycleFields()

~subCycleFields ( )
inline

Destructor.

Definition at line 182 of file subCycle.H.

References forAll, UPtrList< T >::size(), subCycleFields< GeometricField >::time(), and TimeState::timeIndex().

Here is the call graph for this function:

Member Function Documentation

◆ time()

const Time& time ( ) const
inline

Access to time.

Definition at line 200 of file subCycle.H.

Referenced by subCycleFields< GeometricField >::~subCycleFields().

Here is the caller graph for this function:

◆ updateTimeIndex()

void updateTimeIndex ( )
inline

Correct the time index of the fields 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 211 of file subCycle.H.

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