Skip to content

Commit b002c97

Browse files
refactor: mark modified_unknowns! as public
1 parent 2c0aaa8 commit b002c97

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

docs/src/API/System.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,4 +211,5 @@ ModelingToolkit.collect_scoped_vars!
211211
ModelingToolkit.collect_var_to_name!
212212
ModelingToolkit.collect_vars!
213213
ModelingToolkit.eqtype_supports_collect_vars
214+
ModelingToolkit.modified_unknowns!
214215
```

src/ModelingToolkit.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ export DynamicOptSolution
343343
@public VariableDescription, VariableInput, VariableIrreducible, VariableMisc
344344
@public VariableOutput, VariableStatePriority, VariableUnit, collect_scoped_vars!
345345
@public collect_var_to_name!, collect_vars!, eqtype_supports_collect_vars, hasdefault
346-
@public getdefault, setdefault, iscomplete, isparameter
346+
@public getdefault, setdefault, iscomplete, isparameter, modified_unknowns!
347347

348348
for prop in [SYS_PROPS; [:continuous_events, :discrete_events]]
349349
getter = Symbol(:get_, prop)

src/problems/jumpproblem.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,13 @@ function get_variables!(dep, jump::MassActionJump, variables)
210210
end
211211

212212
### Functions to determine which unknowns are modified by a given jump
213+
214+
"""
215+
$(TYPEDSIGNATURES)
216+
217+
Push to `munknowns` the variables modified by jump `jump`. `sts` is the list of unknowns of
218+
the system. Return the modified `munknowns`.
219+
"""
213220
function modified_unknowns!(munknowns, jump::Union{ConstantRateJump, VariableRateJump}, sts)
214221
for eq in jump.affect!
215222
st = eq.lhs

0 commit comments

Comments
 (0)