Skip to content

Commit

Permalink
Add a note to the docstring about initialize and finalize
Browse files Browse the repository at this point in the history
  • Loading branch information
BenChung committed Oct 29, 2024
1 parent 219c405 commit 98a2bea
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/systems/callbacks.jl
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ DAEs will be reinitialized using `reinitializealg` (which defaults to `SciMLBase
This reinitialization algorithm ensures that the DAE is satisfied after the callback runs. The default value of `CheckInit` will simply validate
that the newly-assigned values indeed satisfy the algebraic system; see the documentation on DAE initialization for a more detailed discussion of
initialization.
Initial and final affects can also be specified with SCC, which are specified identically to positive and negative edge affects. Initialization affects
will run as soon as the solver starts, while finalization affects will be executed after termination.
"""
struct SymbolicContinuousCallback
eqs::Vector{Equation}
Expand Down

0 comments on commit 98a2bea

Please sign in to comment.