Skip to content

Commit cedc435

Browse files
committed
formatting
1 parent e46d155 commit cedc435

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

src/systems/systems.jl

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,19 @@ end
77
$(SIGNATURES)
88
99
Structurally simplify algebraic equations in a system and compute the
10-
topological sort of the observed equations. When `simplify=true`, the `simplify`
11-
function will be applied during the tearing process. The kwargs
12-
`allow_symbolic=false`, `allow_parameter=true`, and `conservative=false` which
13-
limits the coefficient types during tearing. In particular, `conservative=true`
14-
limits tearing to only solve for trivial linear systems where the coefficient
15-
has the absolute value of ``1``. The kwarg `fully_determined=true` controls whether or not
16-
an error will be thrown if the number of equations don't match the number of inputs,
17-
outputs, and equations.
10+
topological sort of the observed equations in `sys`.
1811
19-
The optional argument `io` may take a tuple `(inputs, outputs)`.
20-
This will convert all `inputs` to parameters and allow them to be unconnected, i.e.,
21-
simplification will allow models where `n_unknowns = n_equations - n_inputs`.
12+
### Optional Arguments:
13+
+ 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`.
14+
15+
### Optional Keyword Arguments:
16+
+ When `simplify=true`, the `simplify` function will be applied during the tearing process.
17+
+ `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``.
18+
+ `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.
2219
"""
2320
function structural_simplify(
2421
sys::AbstractSystem, io = nothing; simplify = false, split = true,
22+
allow_symbolic = true, allow_parameter = true, conservative = false, fully_determined = true,
2523
kwargs...)
2624
newsys′ = __structural_simplify(sys, io; simplify, kwargs...)
2725
if newsys′ isa Tuple

0 commit comments

Comments
 (0)