A class for managing sub-cycling times. More...

Inheritance diagram for subCycleTime:

Public Member Functions
	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

A class for managing sub-cycling times.

Source files

Definition at line 46 of file subCycleTime.H.

Constructor & Destructor Documentation

◆ subCycleTime()

subCycleTime	(	Time &	runTime,
		const label	nCycle
	)

Construct referencing the original time and number of sub-cycles.

Definition at line 25 of file subCycleTime.C.

References Time::subCycle().

Here is the call graph for this function:

◆ ~subCycleTime()

~subCycleTime ( )

Destructor.

Definition at line 41 of file subCycleTime.C.

Member Function Documentation

◆ index()

label index ( ) const

inline

Return the current sub-cycle index.

Definition at line 87 of file subCycleTime.H.

◆ nSubCycles()

label nSubCycles ( ) const

inline

Return the total number of sub-cycles.

Definition at line 95 of file subCycleTime.H.

◆ status()

bool status ( ) const

True if the sub-cycle is active.

Definition at line 49 of file subCycleTime.C.

◆ end()

bool end ( ) const

Return true if the number of sub-cycles has been reached.

Definition at line 55 of file subCycleTime.C.

◆ endSubCycle()

void endSubCycle ( )

End the sub-cycling and reset the time-state.

Definition at line 61 of file subCycleTime.C.

Referenced by CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::motion(), and subCycle< GeometricField >::~subCycle().

Here is the caller graph for this function:

◆ loop()

bool loop ( )

True if looping is active, increments the index.

Example usage,

while (subcycle.loop())
{
    solve;
}

Definition at line 74 of file subCycleTime.C.

◆ operator++() [1/2]

Foam::subCycleTime & operator++ ( )

Prefix increment.

Definition at line 89 of file subCycleTime.C.

◆ operator++() [2/2]

Foam::subCycleTime & operator++ ( int )

Postfix increment, this is identical to the prefix increment.

Definition at line 105 of file subCycleTime.C.

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

src/OpenFOAM/db/Time/subCycleTime.H
src/OpenFOAM/db/Time/subCycleTime.C

Public Member Functions