Public Member Functions | List of all members
subCycle< GeometricField > Class Template Reference

Perform a subCycleTime on a field. More...

Inheritance diagram for subCycle< GeometricField >:
Inheritance graph
[legend]
Collaboration diagram for subCycle< GeometricField >:
Collaboration graph
[legend]

Public Member Functions

 subCycle (GeometricField &gf, const label nSubCycles)
 Construct field and number of sub-cycles. More...
 
 ~subCycle ()
 Destructor. More...
 
- Public Member Functions inherited from subCycleField< GeometricField >
 subCycleField (GeometricField &gf)
 Construct field and number of sub-cycles. More...
 
 ~subCycleField ()
 Destructor. More...
 
void updateTimeIndex ()
 Correct the time index of the field to correspond to. More...
 
- Public Member Functions inherited from subCycleTime
 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...
 
subCycleTimeoperator++ ()
 Prefix increment. More...
 
subCycleTimeoperator++ (int)
 Postfix increment. More...
 

Detailed Description

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

Perform a subCycleTime on a field.

Definition at line 106 of file subCycle.H.

Constructor & Destructor Documentation

◆ subCycle()

subCycle ( GeometricField gf,
const label  nSubCycles 
)
inline

Construct field and number of sub-cycles.

Definition at line 125 of file subCycle.H.

References subCycleField< GeometricField >::updateTimeIndex().

Here is the call graph for this function:

◆ ~subCycle()

~subCycle ( )
inline

Destructor.

End the subCycleTime, which restores the time state

Definition at line 137 of file subCycle.H.


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