Perform a subCycleTime on a field. More...

Inheritance diagram for subCycle< GeometricField >:

Collaboration diagram for subCycle< GeometricField >:

Public Member Functions
	subCycle (GeometricField &gf, const label nCycles)
	Construct field and number of sub-cycles. More...

	~subCycle ()
	Destructor. More...

Public Member Functions inherited from subCycleField< GeometricField >
	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...

Public Member Functions inherited from subCycleTime
	subCycleTime (Time &runTime, const label nCycle)
	Construct referencing the original time and number of sub-cycles. More...

	~subCycleTime ()
	Destructor. More...

label	index () const
	Return the current sub-cycle index. More...

label	nSubCycles () const
	Return the total number of sub-cycles. More...

bool	status () const
	True if the sub-cycle is active. More...

bool	end () const
	Return true if the number of sub-cycles has been reached. More...

void	endSubCycle ()
	End the sub-cycling and reset the time-state. More...

bool	loop ()
	True if looping is active, increments the index. More...

subCycleTime &	operator++ ()
	Prefix increment. More...

subCycleTime &	operator++ (int)
	Postfix increment, this is identical to the prefix increment. More...

Detailed Description

Perform a subCycleTime on a field.

Definition at line 123 of file subCycle.H.

Constructor & Destructor Documentation

inline

Construct field and number of sub-cycles.

Definition at line 142 of file subCycle.H.

Here is the call graph for this function:

~subCycle ( )

inline

Destructor.

End the subCycleTime, which restores the time state

Definition at line 154 of file subCycle.H.

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