Description
Retrieves convergence information about the input during a simulation. Typically, this will only be called in your model's Iteration event.
Syntax
object.ConvergenceData()
Arguments
None.
Return Value
(RDKConvergenceData) – a type with the following definition:
| Public Type RDKConvergenceData | |
| Stats As RDKStatistics | the input's statistics |
| MeanChange As Double | relative change in mean since the previous check |
| StdDevChange As Double | relative change in stdev since the previous check |
| AveragePercentileChange As Double | average relative change in the 19 percentiles |
| NumCalls As Long | number of times convergence has been checked |
| NumConsecutiveCallsConverged As Long | number of times input is "converged" (in a row) |
| IsConverged As Boolean | is the input "converged" (as defined using the RDKSettings object AutoStopPercentage change property) |
| End Type |
Example
if myInput.ConvergenceData.IsConverged then MsgBox "Input is Converged"