KSLCore/ksl.controls.experiments/DesignedExperiment/simulate

simulate

fun simulate(iterator: Iterator<DesignPoint>, numRepsPerDesignPoint: Int? = null, clearRuns: Boolean = true, addRuns: Boolean = true, onDesignPointComplete: (designPoint: DesignPoint, snapshot: SimulationSnapshot.ExperimentCompleted?) -> Unit? = null, onDesignPointReplications: (experimentName: String, replications: List<SimulationSnapshot.ReplicationCompleted>) -> Unit? = null)(source)

Causes all design points to be simulated as presented by the iterator using the number of replications specified by the design points.

Parameters

iterator

an iterator that presents the design points to simulate. If the iterator is empty then a warning is printed.

numRepsPerDesignPoint

the number of replications per design point. If null (the default), defaultNumRepsPerDesignPoint is used when it is greater than 0; otherwise, the replication specification is obtained from each design point. If a value greater than 0 is supplied, the value is used for every executed design point.

clearRuns

indicates that any previous simulation runs for the design points will be cleared prior to executing these design points. The default is true.

addRuns

If true the executed simulations will be added to the executed simulation runs. The default is true.