Merge pull request #317 from JuliaDynamics/hw/callbacks

improve callback system

Author: hexaeder

NEWS.md

@@ -1,5 +1,13 @@
 # NetworkDynamics Release Notes
 
+## v0.10.10 Changelog
+- [#317](https://github.com/JuliaDynamics/NetworkDynamics.jl/pull/317) Enhanced callback system with negative affect support and runtime callback injection:
+  - Add `affect_neg!` parameter to `ContinuousComponentCallback` and `VectorContinuousComponentCallback` for handling downcrossing events
+  - Add ability to inject additional callbacks at runtime via `get_callbacks(nw, additional_callbacks)` without storing them in component metadata
+  - Add `NetworkDynamics.pretty_f()` debugging utility for pretty-printing MTK-generated functions
+  - Improve MTK integration warnings for nested event systems
+  - Better initialization error messages with specific variable information when NaN values are detected
+
 ## v0.10.9 Changelog
 - [#314](https://github.com/JuliaDynamics/NetworkDynamics.jl/pull/314) Consolidate deprecated functionality: all deprecated functionality moved to dedicated `src/deprecated.jl` file for easier maintenance
 

docs/src/API.md

@@ -219,6 +219,7 @@ has_callback
 get_callbacks(::NetworkDynamics.ComponentModel)
 set_callback!
 add_callback!
+delete_callbacks!
 ```
 
 ## Sparsity Detection
@@ -253,6 +254,7 @@ ff_to_constraint
 Base.copy(::NetworkDynamics.ComponentModel)
 extract_nw
 implicit_output
+NetworkDynamics.pretty_f
 ```
 
 ## NetworkDynamicsInspector API

ext/MTKExt_utils.jl

@@ -149,16 +149,28 @@ function generate_massmatrix(eqs::AbstractVector{Equation})
 end
 
 function warn_missing_features(sys)
-    cev = ModelingToolkit.get_continuous_events(sys)
-    dev = ModelingToolkit.get_discrete_events(sys)
+    cev = _collect_continuous_events(sys)
+    dev = _collect_discrete_events(sys)
     if !isempty(cev) || !isempty(dev)
-        @warn "Model has attached events, which is not supported."
+        @warn "MTK-Model $(sys.name) contains events. They will be ignored by NetworkDynamics.jl. Use ComponentCallbacks on a component level for that!"
     end
 
     if !isempty(ModelingToolkit.initialization_equations(sys))
         @warn "Model has explicit init equation. Those are currently ignored by NetworkDynamics.jl."
     end
 end
+function _collect_continuous_events(sys)
+    vcat(
+        ModelingToolkit.get_continuous_events(sys),
+        [_collect_continuous_events(sys) for sys in ModelingToolkit.get_systems(sys)]...
+    )
+end
+function _collect_discrete_events(sys)
+    vcat(
+        ModelingToolkit.get_discrete_events(sys),
+        [_collect_discrete_events(sys) for sys in ModelingToolkit.get_systems(sys)]...
+    )
+end
 
 function check_metadata(exprs)
     nometadata = []

src/NetworkDynamics.jl

@@ -23,6 +23,7 @@ using Random: Random
 using Static: Static, StaticInt
 using SciMLBase: VectorContinuousCallback, CallbackSet, DiscreteCallback
 using DiffEqCallbacks: DiffEqCallbacks
+using MacroTools: postwalk, @capture
 
 @static if VERSION ≥ v"1.11.0-0"
     using Base: AnnotatedIOBuffer, AnnotatedString
@@ -79,7 +80,6 @@ export DiscreteComponentCallback, PresetTimeComponentCallback
 export SymbolicView
 include("callbacks.jl")
 
-using MacroTools: postwalk
 export @initconstraint, InitConstraint
 export @initformula, InitFormula
 include("init_constraints.jl")
@@ -100,7 +100,7 @@ export has_init, get_init, set_init!, delete_init!, strip_inits!
 export has_bounds, get_bounds, set_bounds!, delete_bounds!, strip_bounds!
 export has_graphelement, get_graphelement, set_graphelement!
 export get_initial_state, dump_initial_state, dump_state
-export has_callback, get_callbacks, set_callback!, add_callback!
+export has_callback, get_callbacks, set_callback!, add_callback!, delete_callbacks!
 export has_initconstraint, get_initconstraints, set_initconstraint!, add_initconstraint!, delete_initconstraints!
 export has_initformula, get_initformulas, set_initformula!, add_initformula!, delete_initformulas!
 export has_position, get_position, set_position!