subCycleField< GeometricField > Class Template Reference

Inheritance diagram for subCycleField< GeometricField >:

Collaboration diagram for subCycleField< GeometricField >:

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

Private Attributes
GeometricField &	gf_
	Reference to the field being sub-cycled. More...
GeometricField &	gf0_
	Reference to the field old-time field being sub-cycled. More...
GeometricField	gf_0_
	Copy of the "real" old-time value of the field. More...

Detailed Description

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

Definition at line 46 of file subCycle.H.

Constructor & Destructor Documentation

subCycleField()

subCycleField ( GeometricField &  gf )

inline

Construct field and number of sub-cycles.

Definition at line 67 of file subCycle.H.

~subCycleField()

~subCycleField ( )

inline

Destructor.

Definition at line 76 of file subCycle.H.

References subCycleField< GeometricField >::gf0_, subCycleField< GeometricField >::gf_, subCycleField< GeometricField >::gf_0_, and GeometricField::timeIndex().

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

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

Here is the caller graph for this function:

Field Documentation

gf_

GeometricField& gf_

private

Reference to the field being sub-cycled.

Definition at line 51 of file subCycle.H.

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

gf0_

GeometricField& gf0_

private

Reference to the field old-time field being sub-cycled.

Needed to avoid calls to oldTime() which may cause unexpected updates of the old-time field

Definition at line 56 of file subCycle.H.

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

gf_0_

GeometricField gf_0_

private

Copy of the "real" old-time value of the field.

Definition at line 59 of file subCycle.H.

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

---

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

• src/OpenFOAM/algorithms/subCycle/subCycle.H