Skip to content

Commit a69e7ae

Browse files
authored
Document io argument to structural_simplify
In order to - Make it easier to understand - Mark as public interface to avoid functionality being broken. This is motivated by external packages that may implement functionality making use of this.
1 parent 74e2571 commit a69e7ae

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/systems/abstractsystem.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -955,6 +955,10 @@ topological sort of the observed equations. When `simplify=true`, the `simplify`
955955
function will be applied during the tearing process. It also takes kwargs
956956
`allow_symbolic=false` and `allow_parameter=true` which limits the coefficient
957957
types during tearing.
958+
959+
The optional argument `io` may take a tuple `(inputs, outputs)`.
960+
This will convert all `inputs` to parameters and allow them to be unconnected, i.e.,
961+
simplification will allow models where `n_states = n_equations - n_inputs`.
958962
"""
959963
function structural_simplify(sys::AbstractSystem, io = nothing; simplify = false, kwargs...)
960964
sys = expand_connections(sys)

0 commit comments

Comments
 (0)