FreeFOAM The Cross-Platform CFD Toolkit
subCycleTime Class Reference

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

#include <OpenFOAM/subCycleTime.H>


Detailed Description

A class for managing sub-cycling times.

Source files

Definition at line 49 of file subCycleTime.H.

+ Inheritance diagram for subCycleTime:

List of all members.

Public Member Functions

 subCycleTime (Time &, const label nSubCycles)
 Construct from original time and number of sub-cycles.
 ~subCycleTime ()
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.
subCycleTimeoperator++ ()
 Prefix increment.
subCycleTimeoperator++ (int)
 Postfix increment.

Constructor & Destructor Documentation

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().

Definition at line 42 of file subCycleTime.C.


Member Function Documentation

bool end ( ) const

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

Definition at line 50 of file subCycleTime.C.

void endSubCycle ( )

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

Definition at line 56 of file subCycleTime.C.

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

Foam::subCycleTime & operator++ ( )

Prefix increment.

Definition at line 64 of file subCycleTime.C.

Foam::subCycleTime & operator++ ( int  )

Postfix increment.

Definition at line 72 of file subCycleTime.C.


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