Skip to content

Commit 6fb9889

Browse files
committed
document the fully_determined kwarg to structural_simplify
1 parent b0542be commit 6fb9889

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/systems/systems.jl

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,19 @@ $(SIGNATURES)
88
99
Structurally simplify algebraic equations in a system and compute the
1010
topological sort of the observed equations. When `simplify=true`, the `simplify`
11-
function will be applied during the tearing process. It also takes kwargs
12-
`allow_symbolic=false` and `allow_parameter=true` which limits the coefficient
13-
types during tearing.
11+
function will be applied during the tearing process. The kwargs
12+
`allow_symbolic=false` and `allow_parameter=true` limit the coefficient
13+
types during tearing. The kwarg `fully_determined=true` controls whether or not
14+
an error will be thrown if the number of equations don't match the number of inputs,
15+
outputs, and equations.
1416
1517
The optional argument `io` may take a tuple `(inputs, outputs)`.
1618
This will convert all `inputs` to parameters and allow them to be unconnected, i.e.,
1719
simplification will allow models where `n_unknowns = n_equations - n_inputs`.
1820
"""
1921
function structural_simplify(
2022
sys::AbstractSystem, io = nothing; simplify = false, split = true,
23+
allow_symbolic = false, allow_parameter = false, fully_determined = true,
2124
kwargs...)
2225
newsys′ = __structural_simplify(sys, io; simplify, kwargs...)
2326
if newsys′ isa Tuple

0 commit comments

Comments
 (0)