subCycleTime Class Reference

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

Inheritance diagram for subCycleTime:

Public Member Functions
	subCycleTime (Time &runTime, const label nCycle)
	~subCycleTime ()
label	index () const
label	nSubCycles () const
bool	status () const
bool	end () const
void	endSubCycle ()
bool	loop ()
subCycleTime &	operator++ ()
subCycleTime &	operator++ (int)

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
	)

Definition at line 25 of file subCycleTime.C.

References Time::subCycle().

Here is the call graph for this function:

~subCycleTime()

~subCycleTime

(

)

Definition at line 41 of file subCycleTime.C.

Member Function Documentation

index()

label index ( ) const

inline

Definition at line 75 of file subCycleTime.H.

nSubCycles()

label nSubCycles ( ) const

inline

Definition at line 81 of file subCycleTime.H.

status()

bool status

(

)

const

Definition at line 49 of file subCycleTime.C.

end()

bool end

(

)

const

Definition at line 55 of file subCycleTime.C.

endSubCycle()

void endSubCycle

(

)

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

(

)

Definition at line 74 of file subCycleTime.C.

operator++() [1/2]

Foam::subCycleTime & operator++

(

)

Definition at line 89 of file subCycleTime.C.

operator++() [2/2]

Foam::subCycleTime & operator++

(

int

)

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