subCycle< GeometricField, SubCycleField > Class Template Reference

Perform a subCycleTime on a field or list of fields. More...

Inheritance diagram for subCycle< GeometricField, SubCycleField >:
Collaboration diagram for subCycle< GeometricField, SubCycleField >:

Public Member Functions

 subCycle (typename SubCycleField< GeometricField >::FieldsType &gf, const label nSubCycles)
 Construct field and number of sub-cycles. More...
 
 subCycle (const subCycle< GeometricField > &)=delete
 Disallow default bitwise copy construction. More...
 
 ~subCycle ()
 Destructor. More...
 
void operator= (const subCycle< GeometricField > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from subCycleField< GeometricField >
 subCycleField (GeometricField &gf, const label nSubCycles)
 Construct from field and number of sub-cycles. More...
 
 ~subCycleField ()
 Destructor. More...
 
const Timetime () const
 Access to time. 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...
 

Additional Inherited Members

- Public Types inherited from subCycleField< GeometricField >
typedef GeometricField FieldsType
 Type of the field. More...
 

Detailed Description

template<class GeometricField, template< class > class SubCycleField = subCycleField>
class Foam::subCycle< GeometricField, SubCycleField >

Perform a subCycleTime on a field or list of fields.

Definition at line 231 of file subCycle.H.

Constructor & Destructor Documentation

◆ subCycle() [1/2]

subCycle ( typename SubCycleField< GeometricField >::FieldsType gf,
const label  nSubCycles 
)
inline

Construct field and number of sub-cycles.

Definition at line 242 of file subCycle.H.

References subCycleTime::nSubCycles(), and subCycleField< GeometricField >::updateTimeIndex().

Here is the call graph for this function:

◆ subCycle() [2/2]

subCycle ( const subCycle< GeometricField > &  )
delete

Disallow default bitwise copy construction.

References subCycleTime::endSubCycle().

Here is the call graph for this function:

◆ ~subCycle()

~subCycle ( )
inline

Destructor.

End the subCycleTime, which restores the time state

Definition at line 265 of file subCycle.H.

Member Function Documentation

◆ operator=()

void operator= ( const subCycle< GeometricField > &  )
delete

Disallow default bitwise assignment.


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