Perform a subCycleTime on a field. More...

#include <subCycle.H>

Inheritance diagram for subCycle< GeometricField >:

[legend]

Collaboration diagram for subCycle< GeometricField >:

[legend]

Public Member Functions
	subCycle (GeometricField &gf, const label nCycles)
	Construct field and number of sub-cycles.
	~subCycle ()
	Destructor.
Public Member Functions inherited from subCycleField< GeometricField >
	subCycleField (GeometricField &gf)
	Construct field and number of sub-cycles.
	~subCycleField ()
	Destructor.
void	updateTimeIndex ()
	Correct the time index of the field to correspond to.
Public Member Functions inherited from subCycleTime
	subCycleTime (Time &runTime, const label nCycle)
	Construct referencing the original time and number of sub-cycles.
	~subCycleTime ()
	Destructor.
label	index () const
	Return the current sub-cycle index.
label	nSubCycles () const
	Return the total number of sub-cycles.
bool	status () const
	True if the sub-cycle is active.
bool	end () const
	Return true if the number of sub-cycles has been reached.
void	endSubCycle ()
	End the sub-cycling and reset the time-state.
bool	loop ()
	True if looping is active, increments the index.
subCycleTime &	operator++ ()
	Prefix increment.
subCycleTime &	operator++ (int)
	Postfix increment, this is identical to the prefix increment.

Detailed Description

template<class GeometricField>
class Foam::subCycle< GeometricField >

Perform a subCycleTime on a field.

Definition at line 133 of file subCycle.H.

Constructor & Destructor Documentation

template<class GeometricField>

subCycle	(	GeometricField &	gf,
		const label	nCycles )

inline

Construct field and number of sub-cycles.

Definition at line 158 of file subCycle.H.

Here is the call graph for this function:

template<class GeometricField>

~subCycle ( )

inline

Destructor.

End the subCycleTime, which restores the time state

Definition at line 173 of file subCycle.H.

Here is the call graph for this function:

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