Skip to content

Commit

Permalink
Merge pull request #2880 from MasonProtter/document-fully-determined
Browse files Browse the repository at this point in the history
document the `fully_determined` kwarg to structural_simplify
  • Loading branch information
ChrisRackauckas authored Jul 20, 2024
2 parents 6cca2ff + cedc435 commit 31059a3
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/systems/systems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ end
$(SIGNATURES)
Structurally simplify algebraic equations in a system and compute the
topological sort of the observed equations. When `simplify=true`, the `simplify`
function will be applied during the tearing process. It also takes kwargs
`allow_symbolic=false`, `allow_parameter=true`, and `conservative=false` which
limits the coefficient types during tearing. In particular, `conservative=true`
limits tearing to only solve for trivial linear systems where the coefficient
has the absolute value of ``1``.
topological sort of the observed equations in `sys`.
The optional argument `io` may take a tuple `(inputs, outputs)`.
This will convert all `inputs` to parameters and allow them to be unconnected, i.e.,
simplification will allow models where `n_unknowns = n_equations - n_inputs`.
### Optional Arguments:
+ optional argument `io` may take a tuple `(inputs, outputs)`. This will convert all `inputs` to parameters and allow them to be unconnected, i.e., simplification will allow models where `n_unknowns = n_equations - n_inputs`.
### Optional Keyword Arguments:
+ When `simplify=true`, the `simplify` function will be applied during the tearing process.
+ `allow_symbolic=false`, `allow_parameter=true`, and `conservative=false` limit the coefficient types during tearing. In particular, `conservative=true` limits tearing to only solve for trivial linear systems where the coefficient has the absolute value of ``1``.
+ `fully_determined=true` controls whether or not an error will be thrown if the number of equations don't match the number of inputs, outputs, and equations.
"""
function structural_simplify(
sys::AbstractSystem, io = nothing; simplify = false, split = true,
allow_symbolic = true, allow_parameter = true, conservative = false, fully_determined = true,
kwargs...)
newsys′ = __structural_simplify(sys, io; simplify, kwargs...)
if newsys′ isa Tuple
Expand Down

0 comments on commit 31059a3

Please sign in to comment.