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

Inheritance diagram for subCycleTime:

Public Member Functions
	subCycleTime (Time &, const label nSubCycles)
	Construct from original time and number of sub-cycles. More...

	~subCycleTime ()
	Destructor. 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...

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

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

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

subCycleTime &	operator++ (int)
	Postfix increment. More...

Detailed Description

A class for managing sub-cycling times.

Source files

Definition at line 48 of file subCycleTime.H.

Constructor & Destructor Documentation

◆ subCycleTime()

subCycleTime	(	Time &	t,
		const label	nSubCycles
	)

Construct from original time and number of sub-cycles.

Definition at line 30 of file subCycleTime.C.

References Time::subCycle().

Here is the call graph for this function:

◆ ~subCycleTime()

~subCycleTime ( )

Destructor.

Definition at line 45 of file subCycleTime.C.

Member Function Documentation

◆ end()

bool end ( ) const

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

Definition at line 53 of file subCycleTime.C.

◆ endSubCycle()

void endSubCycle ( )

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

Definition at line 59 of file subCycleTime.C.

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

Here is the caller graph for this function:

◆ nSubCycles()

label nSubCycles ( ) const

inline

Return the total number of sub-cycles.

Definition at line 78 of file subCycleTime.H.

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

Here is the caller graph for this function:

◆ index()

label index ( ) const

inline

Return the current sub-cycle index.

Definition at line 84 of file subCycleTime.H.

◆ operator++() [1/2]

Foam::subCycleTime & operator++ ( )

Prefix increment.

Definition at line 70 of file subCycleTime.C.

◆ operator++() [2/2]

Foam::subCycleTime & operator++ ( int )

Postfix increment.

Definition at line 83 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