SimulationObject.simulate

SimulationObject.simulate(time_vector: List[double] = self.time_vector, time_unit: str = self.time_unit, state_values: List[double] = self.state_values, derivative_values: List[double] = self.derivative_values, parameter_values: List[double] = self.parameter_values, reset: bool = False, options: Dict[str, double] = self.options, iterative: bool = True) -> None

Runs simulation over the time points defined in time_vector in the SimulationObject object. Simulation results are stored in feature_data of the SimulationObject object.

Parameters

time_vector

time

t

Any sequence of floats representing the time points to be simulated. Will be converted to a numpy.array and assigned to self.time_vector.

time_unit

tu

String representing the time unit of the simulation. Will be assigned to self.time_unit. Valid values for time units.

state_values

x0

Any sequence of floats representing initial state values for the simulation. Will be converted to a numpy.array and assigned to self.state_values.

derivative_values

xdot

Any sequence of floats representing initial derivative values for the simulation. Only relevant for DAE models. Will be converted to a numpy.array and assigned to self.derivative_values.

parameter_values

theta

p

Any sequence of floats representing parameter values for the simulation. Will be converted to a numpy.array and assigned to self.parameter_values.

reset

If true, equivalent to running SimulationObject.reset_simulation prior to simulation.

options

A Dict of options for the integrator. See simulation options for available options. Will be assigned to self.options.

iterative

A flag for controlling whether to break up the simulation into several smaller simulations. Can improve simulation stability and required for proper functionality of activities.

Return type

None

Return value

None