Skip to content

Commit 7769b5b

Browse files
docs: improve docstring for mtkcompile
1 parent f4783b0 commit 7769b5b

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/systems/systems.jl

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,18 @@ end
99
"""
1010
$(SIGNATURES)
1111
12-
Structurally simplify algebraic equations in a system and compute the
13-
topological sort of the observed equations in `sys`.
12+
Compile the given system into a form that ModelingToolkit can generate code for. Also
13+
performs a variety of symbolic-numeric enhancements. For ODEs, this includes processes
14+
such as order reduction, index reduction, alias elimination and tearing. A subset of the
15+
unknowns of the system may be eliminated as observables, eliminating the need for the
16+
numerical solver to solve for these variables.
17+
18+
Does not rely on metadata to identify variables/parameters/brownians. Instead, queries
19+
the system for which symbolic quantites belong to which category. Any variables not
20+
present in the equations of the system will be removed in this process.
21+
22+
# Keyword Arguments
1423
15-
### Optional Keyword Arguments:
1624
+ When `simplify=true`, the `simplify` function will be applied during the tearing process.
1725
+ `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``.
1826
+ `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.

0 commit comments

Comments
 (0)