Model class
Each mathematical model will be represented by a class, from which model objects can be created.
All model classes inherits their properties from the same base class, the ModelObject
class.
Public members
The following members can be accessed directly.
Member | Type | Description |
---|---|---|
compartment |
str |
Read only |
derivative_values |
numpy.array[float] |
Accepts any sequence of floats |
event_names |
list[str] |
|
feature_names |
list[str] |
|
feature_units |
list[str] |
Read only |
input_names |
list[str] |
|
name |
str |
|
output_names |
list[str] |
|
parameter_names |
list[str] |
|
parameter_values |
numpy.array[float] |
Accepts any sequence of floats |
state_names |
list[str] |
|
state_values |
numpy.array[float] |
Accepts any sequence of floats |
time_unit |
str |
See time units |
Public methods
Method |
Description |
---|---|
differential_states |
Returns a numpy array of booleans, showing if respective state is a differential state |
has_algebraic_equations |
Returns true if simulation has a DAE model |
mandatory_inputs |
Shows which inputs are mandatory for the model |
reset_parameters |
Resets parameters to their default values |
reset |
Resets state and derivative values to their default values |