Skip to content

Commit 40d84fa

Browse files
Update callback_functions.md
1 parent 4867f7a commit 40d84fa

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

docs/src/features/callback_functions.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,16 @@ types can be used to build libraries of extension behavior.
88
## The Callback Types
99

1010
The callback types are defined as follows. There are three primitive callback types: the `ContinuousCallback`, `DiscreteCallback` and the `VectorContinuousCallback`:
11-
- The [`ContinuousCallback`](@ref) is applied when a given continuous *condition function* hits zero. This hitting can happen even within an integration step and the solver must be able to detect it and adjust the integration step accordingly. This type of callback implements what is known in other problem solving environments as an *Event*.
12-
- The [`DiscreteCallback`](@ref) is applied when its *condition function* is `true`, but the condition is only evaluated at the end of every integration step.
13-
- The [`VectorContinuousCallback`](@ref) works like a vector of `ContinuousCallbacks` and lets the user specify which callback is called when.
11+
12+
- The [`ContinuousCallback`](@ref) is applied when a given continuous *condition function* hits zero. This hitting can happen even within
13+
an integration step and the solver must be able to detect it and adjust the integration step accordingly. This type of callback implements
14+
what is known in other problem solving environments as an *Event*.
15+
- The [`DiscreteCallback`](@ref) is applied when its *condition function* is `true`, but the condition is only evaluated at the end of every
16+
integration step.
17+
- The [`VectorContinuousCallback`](@ref) works like a vector of `ContinuousCallbacks` and lets the user specify a vector of continuous callbacks
18+
each with simultanious rootfinding equations. The effect that is applied is the effect corresponding to the first/earliest condition that is
19+
satisfied. A `VectorContinuousCallback` is more efficient than a `CallbackSet` of `ContinuousCallback`s as the number of callbacks grows. As
20+
such, it's a slightly more involved definition which gives better scaling.
1421

1522
### ContinuousCallback
1623

0 commit comments

Comments
 (0)