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

Sets/changes the convergence tolerance for a while control loop. More...

Private Member Functions

subroutine cmfe_controlloop_absolutetolerancesetnumber0 (problemUserNumber, controlLoopIdentifier, absoluteTolerance, err)
 Sets/changes the maximum iterations for a while control loop identified by user numbers. More...
 
subroutine cmfe_controlloop_absolutetolerancesetnumber1 (problemUserNumber, controlLoopIdentifiers, absoluteTolerance, err)
 Sets/changes the maximum iterations for a while control loop identified by user numbers. More...
 
subroutine cmfe_controlloop_absolutetolerancesetobj (controlLoop, absoluteTolerance, err)
 Sets/changes the maximum iterations for a while control loop identified by an object. More...
 

Detailed Description

Sets/changes the convergence tolerance for a while control loop.

Todo:
need a get method

Definition at line 1408 of file opencmiss_iron.f90.

Member Function/Subroutine Documentation

subroutine opencmiss_iron::cmfe_controlloop_absolutetoleranceset::cmfe_controlloop_absolutetolerancesetnumber0 ( integer(intg), intent(in)  problemUserNumber,
integer(intg), intent(in)  controlLoopIdentifier,
real(dp), intent(in)  absoluteTolerance,
integer(intg), intent(out)  err 
)
private

Sets/changes the maximum iterations for a while control loop identified by user numbers.

Parameters
[in]problemusernumberThe user number of the problem to set the maximum iterations for.
[in]controlloopidentifierThe control loop identifier.
[in]absolutetoleranceThe absolute tolerance value for a control loop.
[out]errThe error code.

Definition at line 16965 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_controlloop_absolutetoleranceset::cmfe_controlloop_absolutetolerancesetnumber1 ( integer(intg), intent(in)  problemUserNumber,
integer(intg), dimension(:), intent(in)  controlLoopIdentifiers,
real(dp), intent(in)  absoluteTolerance,
integer(intg), intent(out)  err 
)
private

Sets/changes the maximum iterations for a while control loop identified by user numbers.

Parameters
[in]problemusernumberThe user number of the problem to set the maximum iterations for.
[in]controlloopidentifiersThe control loop identifiers.
[in]absolutetoleranceThe absolute tolerance value for a control loop.
[out]errThe error code.

Definition at line 17005 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_controlloop_absolutetoleranceset::cmfe_controlloop_absolutetolerancesetobj ( type(cmfe_controllooptype), intent(inout)  controlLoop,
real(dp), intent(in)  absoluteTolerance,
integer(intg), intent(out)  err 
)
private

Sets/changes the maximum iterations for a while control loop identified by an object.

Parameters
[in,out]controlloopThe control loop to set the maximum iterations for.
[in]absolutetoleranceThe absolute tolerance value for a control loop.
[out]errThe error code.

Definition at line 17045 of file opencmiss_iron.f90.