Skip to content

Commit 2ee9c23

Browse files
committed
mention continuous_events and disrete_events in the documentaion
1 parent 2ddc6e8 commit 2ee9c23

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/src/basics/Events.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ be handled via more [general functional affects](@ref func_affects).
5858

5959
Finally, multiple events can be encoded via a `Vector{Pair{Vector{Equation}, Vector{Equation}}}`.
6060

61+
Given an `AbstractSystem`, one can fetch its continuous events, and the continuous events of any
62+
subsystem inside of it using the `continuous_events(::AbstractSystem)` method, returning a vector
63+
of `ModelingToolkit.SymbolicContinuousCallback` objects.
64+
6165
### Example: Friction
6266

6367
The system below illustrates how continuous events can be used to model Coulomb
@@ -221,6 +225,10 @@ equations can either all change unknowns (i.e. variables) or all change
221225
parameters, but one cannot currently mix unknown variable and parameter changes within one
222226
individual event.
223227

228+
Given an `AbstractSystem`, one can fetch its discrete events, and the discrete events of any
229+
subsystem inside of it using the `discrete_events(::AbstractSystem)` method, returning a vector
230+
of `ModelingToolkit.SymbolicDiscreteCallback` objects.
231+
224232
### Example: Injecting cells into a population
225233

226234
Suppose we have a population of `N(t)` cells that can grow and die, and at time

0 commit comments

Comments
 (0)