Name

analyze — These methods can be used to control the duration of a simulation.

Overview

These methods can be used to control the duration of a simulation. They will start the scheduler and will not return control until after the termination conditions that they specify have been met.

These command are ususally used in batch scripts to automate an analysis. Typically the script will set target parameters, and then call one of these methods. These methods will

  • start the scheduler,

  • wait until the completion criteria have been statisfied,

  • stop the scheduler, and

  • then save the scenario reports into the specified folder.

The analyze command has two alternate forms. The first specifies the number of iterations to wait before checking on the change in the objective function value. If the objective function has changed by less than the specified percent amount then the method will continue.

The other form of the analyze method simply waits until the specified iterations have been executed, and then returns.

For more information check the API documentation for the waitForProgress method in the Control class.

Syntax

void analyze ( String label , int count , double improvement ) 

The command has the following arguments:

label

The name to be given to the scenario when saved. The scenario will be saved in a folder of the same name. If the folder already exists then the data will be overwritten.

count

Then number of iterations to wait before checking the progress of the objective function.

improvement

The value to be compared with the percent amount of change in the objective value function. If this value is zero, then return after waiting for count iterations.

Description

Analyze until less than "improvement" (percent) improvement in "count" iterations and then save in "label".

Syntax

void analyze ( String label , int count ) 

The command has the following arguments:

label

The name to be given to the scenario when saved. The scenario will be saved in a folder of the same name. If the folder already exists then the data will be overwritten.

count

Then number of iterations to wait before checking the progress of the objective function.

Description

Analyze for "count" iterations and then save in "label".