amici.ode_export.Event¶
-
class
amici.ode_export.
Event
(identifier, name, value, state_update, event_observable)[source]¶ An Event defines either a SBML event or a root of the argument of a Heaviside function. The Heaviside functions will be tracked via the vector h during simulation and are needed to inform the ODE solver about a discontinuity in either the right hand side or the states themselves, causing a reinitialization of the solver.
-
__init__
(identifier, name, value, state_update, event_observable)[source] Create a new Event instance.
- Parameters
identifier (
sympy.core.symbol.Symbol
) – unique identifier of the Eventname (
str
) – individual name of the Event (does not need to be unique)value (
sympy.core.expr.Expr
) – formula for the root / trigger functionstate_update (
typing.Optional
[sympy.core.expr.Expr
]) – formula for the bolus function (None for Heaviside functions, zero vector for events without bolus)event_observable (
typing.Optional
[sympy.core.expr.Expr
]) – formula a potential observable linked to the event (None for Heaviside functions, empty events without observable)
Methods Summary
__init__
(identifier, name, value, …)Create a new Event instance.
get_id
()ModelQuantity identifier
get_name
()ModelQuantity name
get_val
()ModelQuantity value
Methods
-
__init__
(identifier, name, value, state_update, event_observable)[source]¶ Create a new Event instance.
- Parameters
identifier (
sympy.core.symbol.Symbol
) – unique identifier of the Eventname (
str
) – individual name of the Event (does not need to be unique)value (
sympy.core.expr.Expr
) – formula for the root / trigger functionstate_update (
typing.Optional
[sympy.core.expr.Expr
]) – formula for the bolus function (None for Heaviside functions, zero vector for events without bolus)event_observable (
typing.Optional
[sympy.core.expr.Expr
]) – formula a potential observable linked to the event (None for Heaviside functions, empty events without observable)
-
get_id
()¶ ModelQuantity identifier
- Return type
- Returns
identifier of the ModelQuantity
-
get_val
()¶ ModelQuantity value
- Return type
- Returns
value of the ModelQuantity
-