Skip to content

set_output_interval

Syntax

set_output_interval(<variable_name>, <days>)

Parameters

<variable_name>
The name of a variable that was declared in the variables block.
<days>
The number of days between recordings of the associated output data.

Description

Action to set the periodicity of output generation for a particular variable during a simulation. When an interval is set, the value of the associated variable is recorded at regular intervals when the interval set matches the day number of the simulation.

E.g.) Specifying an output interval of 2 for some numeric variable x will cause x's value to be recorded every 2 days.

If a non-zero value is specified, regardless of the specified interval, output will also be made on the final day of the simulation. This ensures that the final state is captured, even if the last day does not coincide with the specified interval.

Currently, output intervals can only be set for variables with a shared scope.

Examples

# for some shared list my_list
set_output_interval(my_list, 30)

See Also