Simulation class

This page describes the SimulationObject class.

ODE:s are solved by using the SUNDIALS CVODE integrator, and DAE:s by the SUNDIALS IDA integrator. Current version of the included SUNDIALS library is 7.0.0.

Public members

The following members can be accessed directly.

Member	Type	Description
derivative_values	numpy.array[float]	Accepts any sequence of floats
event_names	list[str]	Read only
event_status	numpy.array[float]	Read only
event_times	numpy.array[float]	Read only
feature_data	numpy.array[float]	Read only
feature_names	list[str]	Read only
feature_units	list[str]	Read only
input_names	list[str]	Read only
options	dict[str, float]	See simulation options
output_names	list[str]	Read only
parameter_names	list[str]	Read only
parameter_values	numpy.array[float]	Accepts any sequence of floats
state_names	list[str]	Read only
state_values	numpy.array[float]	Accepts any sequence of floats
time_unit	str	See time units
time_vector	numpy.array[float]	Accepts any sequence of floats

Public methods

Method	Description
differential_states	Returns a numpy array of booleans, showing if respective state is a differential state
execution_order	Shows the order in which the models will be simulated
feature_data_as_dict	Returns feature_data in Dict format
has_algebraic_equations	Returns true if simulation has a DAE model
reset_parameters	Resets parameters to their default values
reset_simulation	Resets state and derivative values to their default values
simulate	Runs simulation over time points defined in time_vector
validate	Checks if all mandatory model inputs are provided and recalculates execution order of models