subCycleTime Class Reference

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

#include <subCycleTime.H>

Inheritance diagram for subCycleTime:

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

A class for managing sub-cycling times.

Source files

• subCycleTime.H
• subCycleTime.C

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

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

Here is the caller graph for this function:

~subCycleTime()

~subCycleTime

(

)

Destructor.

Definition at line 41 of file subCycleTime.C.

References endSubCycle().

Here is the call graph for this function:

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.

Referenced by loop().

Here is the caller graph for this function:

end()

bool end

(

)

const

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

Definition at line 55 of file subCycleTime.C.

Referenced by multiphaseSystem::solve(), twoPhaseSystem::solve(), and MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi().

Here is the caller graph for this function:

endSubCycle()

void endSubCycle

(

)

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

Definition at line 61 of file subCycleTime.C.

Referenced by subCycle< GeometricField >::~subCycle(), and ~subCycleTime().

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.

References operator++(), and status().

Here is the call graph for this function:

operator++() [1/2]

Foam::subCycleTime & operator++

(

)

Prefix increment.

Definition at line 89 of file subCycleTime.C.

Referenced by loop(), and operator++().

Here is the caller graph for this function:

operator++() [2/2]

Foam::subCycleTime & operator++

(

int

)

Postfix increment, this is identical to the prefix increment.

Definition at line 105 of file subCycleTime.C.

References operator++().

Here is the call graph for this function:

---

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

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