Merge pull request #2567 from MasonProtter/export-events

Document and export `continuous_events` and `discrete_events`

Author: ChrisRackauckas

docs/src/systems/JumpSystem.md

@@ -12,6 +12,7 @@ JumpSystem
   - `get_unknowns(sys)` or `unknowns(sys)`: The set of unknowns in the jump system.
   - `get_ps(sys)` or `parameters(sys)`: The parameters of the jump system.
   - `get_iv(sys)`: The independent variable of the jump system.
+  - `discrete_events(sys)`: The set of discrete events in the jump system.
 
 ## Transformations
 

docs/src/systems/ODESystem.md

@@ -13,6 +13,8 @@ ODESystem
   - `get_ps(sys)` or `parameters(sys)`: The parameters of the ODE.
   - `get_iv(sys)`: The independent variable of the ODE.
   - `get_u0_p(sys, u0map, parammap)` Numeric arrays for the initial condition and parameters given `var => value` maps.
+  - `continuous_events(sys)`: The set of continuous events in the ODE
+  - `discrete_events(sys)`: The set of discrete events in the ODE
 
 ## Transformations
 

docs/src/systems/SDESystem.md

@@ -19,6 +19,8 @@ sde = SDESystem(ode, noiseeqs)
   - `get_unknowns(sys)` or `unknowns(sys)`: The set of unknowns in the SDE.
   - `get_ps(sys)` or `parameters(sys)`: The parameters of the SDE.
   - `get_iv(sys)`: The independent variable of the SDE.
+  - `continuous_events(sys)`: The set of continuous events in the SDE
+  - `discrete_events(sys)`: The set of discrete events in the SDE
 
 ## Transformations
 

src/ModelingToolkit.jl

@@ -35,7 +35,8 @@ using PrecompileTools, Reexport
     using RecursiveArrayTools
 
     using SymbolicIndexingInterface
-    export independent_variables, unknowns, parameters, full_parameters
+    export independent_variables, unknowns, parameters, full_parameters, continuous_events,
+           discrete_events
     import SymbolicUtils
     import SymbolicUtils: istree, arguments, operation, similarterm, promote_symtype,
                           Symbolic, isadd, ismul, ispow, issym, FnType,

src/systems/callbacks.jl

@@ -138,6 +138,14 @@ function namespace_callback(cb::SymbolicContinuousCallback, s)::SymbolicContinuo
         namespace_affects(affects(cb), s))
 end
 
+"""
+    continuous_events(sys::AbstractSystem)::Vector{SymbolicContinuousCallback}
+
+Returns a vector of all the `continuous_events` in an abstract system and its component subsystems.
+The `SymbolicContinuousCallback`s in the returned vector are structs with two fields: `eqs` and
+`affect` which correspond to the first and second elements of a `Pair` used to define an event, i.e.
+`eqs => affect`.
+"""
 function continuous_events(sys::AbstractSystem)
     obs = get_continuous_events(sys)
     filter(!isempty, obs)
@@ -234,6 +242,14 @@ SymbolicDiscreteCallbacks(cb::SymbolicDiscreteCallback) = [cb]
 SymbolicDiscreteCallbacks(cbs::Vector{<:SymbolicDiscreteCallback}) = cbs
 SymbolicDiscreteCallbacks(::Nothing) = SymbolicDiscreteCallback[]
 
+"""
+    discrete_events(sys::AbstractSystem) :: Vector{SymbolicDiscreteCallback}
+
+Returns a vector of all the `discrete_events` in an abstract system and its component subsystems.
+The `SymbolicDiscreteCallback`s in the returned vector are structs with two fields: `condition` and
+`affect` which correspond to the first and second elements of a `Pair` used to define an event, i.e.
+`condition => affect`.
+"""
 function discrete_events(sys::AbstractSystem)
     obs = get_discrete_events(sys)
     systems = get_systems(sys)