OpenCMISS-Iron Internal API Documentation
opencmiss_iron::cmfe_controlloop_timesget Interface Reference

Returns the time parameters for a time control loop. More...

Private Member Functions

subroutine cmfe_controlloop_timesgetnumber0 (problemUserNumber, controlLoopIdentifier, startTime, stopTime, timeIncrement, currentTime, currentLoopIteration, outputIterationNumber, err)
 Returns the time parameters for a time control loop identified by user numbers. More...
 
subroutine cmfe_controlloop_timesgetnumber1 (problemUserNumber, controlLoopIdentifiers, startTime, stopTime, timeIncrement, currentTime, currentLoopIteration, outputIterationNumber, err)
 Returns the time parameters for a time control loop identified by user numbers. More...
 
subroutine cmfe_controlloop_timesgetobj (controlLoop, startTime, stopTime, timeIncrement, currentTime, currentLoopIteration, outputIterationNumber, err)
 Returns the time parameters for a time control loop identified by an object. More...
 

Detailed Description

Returns the time parameters for a time control loop.

Definition at line 1471 of file opencmiss_iron.f90.

Member Function/Subroutine Documentation

subroutine opencmiss_iron::cmfe_controlloop_timesget::cmfe_controlloop_timesgetnumber0 ( integer(intg), intent(in)  problemUserNumber,
integer(intg), intent(in)  controlLoopIdentifier,
real(dp), intent(out)  startTime,
real(dp), intent(out)  stopTime,
real(dp), intent(out)  timeIncrement,
real(dp), intent(out)  currentTime,
integer(intg), intent(out)  currentLoopIteration,
integer(intg), intent(out)  outputIterationNumber,
integer(intg), intent(out)  err 
)
private

Returns the time parameters for a time control loop identified by user numbers.

Parameters
[in]problemusernumberThe user number of the problem to get the time parameters for for.
[in]controlloopidentifierThe control loop identifier.
[out]starttimeOn return, the start time for the time control loop.
[out]stoptimeOn return, the stop time for the time control loop.
[out]timeincrementOn return, the time increment for the time control loop.
[out]currenttimeOn return, the current time for the time control loop.
[out]currentloopiterationOn return, the iteration number for the current loop.
[out]outputiterationnumberOn return, the iteration number for the time control loop.
[out]errThe error code.

Definition at line 17905 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_controlloop_timesget::cmfe_controlloop_timesgetnumber1 ( integer(intg), intent(in)  problemUserNumber,
integer(intg), dimension(:), intent(in)  controlLoopIdentifiers,
real(dp), intent(out)  startTime,
real(dp), intent(out)  stopTime,
real(dp), intent(out)  timeIncrement,
real(dp), intent(out)  currentTime,
integer(intg), intent(out)  currentLoopIteration,
integer(intg), intent(out)  outputIterationNumber,
integer(intg), intent(out)  err 
)
private

Returns the time parameters for a time control loop identified by user numbers.

Parameters
[in]problemusernumberThe user number of the problem to get the time parameters for for.
[in]controlloopidentifiersThe control loop identifier.
[out]starttimeOn return, the start time for the time control loop.
[out]stoptimeOn return, the stop time for the time control loop.
[out]timeincrementOn return, the time increment for the time control loop.
[out]currenttimeOn return, the current time for the time control loop.
[out]currentloopiterationOn return, the iteration number for the current loop.
[out]outputiterationnumberOn return, the iteration number for the time control loop.
[out]errThe error code.

Definition at line 17951 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_controlloop_timesget::cmfe_controlloop_timesgetobj ( type(cmfe_controllooptype), intent(in)  controlLoop,
real(dp), intent(out)  startTime,
real(dp), intent(out)  stopTime,
real(dp), intent(out)  timeIncrement,
real(dp), intent(out)  currentTime,
integer(intg), intent(out)  currentLoopIteration,
integer(intg), intent(out)  outputIterationNumber,
integer(intg), intent(out)  err 
)
private

Returns the time parameters for a time control loop identified by an object.

Parameters
[in]controlloopThe control loop to get the times for.
[out]starttimeOn return, the start time for the time control loop.
[out]stoptimeOn return, the stop time for the time control loop.
[out]timeincrementOn return, the time increment for the time control loop.
[out]currenttimeOn return, the current time for the time control loop.
[out]currentloopiterationOn return, the iteration number for the current loop.
[out]outputiterationnumberOn return, the iteration number for the time control loop.
[out]errThe error code.

Definition at line 17997 of file opencmiss_iron.f90.