FreeFOAM The Cross-Platform CFD Toolkit
subCycle< GeometricField > Class Template Reference

Perform a subCycleTime on a field. More...

#include <OpenFOAM/subCycle.H>


Detailed Description

template<class GeometricField>
class Foam::subCycle< GeometricField >

Perform a subCycleTime on a field.

Definition at line 47 of file subCycle.H.

+ Inheritance diagram for subCycle< GeometricField >:
+ Collaboration diagram for subCycle< GeometricField >:

List of all members.

Public Member Functions

 subCycle (GeometricField &gf, const label nSubCycles)
 Construct field and number of sub-cycles.
 ~subCycle ()
- Public Member Functions inherited from subCycleTime
 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

subCycle ( GeometricField gf,
const label  nSubCycles 
)
inline

Construct field and number of sub-cycles.

Definition at line 74 of file subCycle.H.


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