Skip to content

Commit 78b9f1a

Browse files
committed
improve linearization docstring
1 parent e07cbaf commit 78b9f1a

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/systems/abstractsystem.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1453,8 +1453,8 @@ function markio!(state, orig_inputs, inputs, outputs; check = true)
14531453
end
14541454

14551455
"""
1456-
(; A, B, C, D), simplified_sys = linearize(sys, inputs, outputs; t=0.0, op = Dict(), allow_input_derivatives = false, kwargs...)
1457-
(; A, B, C, D) = linearize(simplified_sys, lin_fun; t=0.0, op = Dict(), allow_input_derivatives = false)
1456+
(; A, B, C, D), simplified_sys = linearize(sys, inputs, outputs; t=0.0, op = Dict(), allow_input_derivatives = false, zero_dummy_der=false, kwargs...)
1457+
(; A, B, C, D) = linearize(simplified_sys, lin_fun; t=0.0, op = Dict(), allow_input_derivatives = false, zero_dummy_der=false)
14581458
14591459
Return a NamedTuple with the matrices of a linear statespace representation
14601460
on the form
@@ -1474,6 +1474,8 @@ the default values of `sys` are used.
14741474
14751475
If `allow_input_derivatives = false`, an error will be thrown if input derivatives (``u̇``) appear as inputs in the linearized equations. If input derivatives are allowed, the returned `B` matrix will be of double width, corresponding to the input `[u; u̇]`.
14761476
1477+
`zero_dummy_der` can be set to automatically set the operating point to zero for all dummy derivatives.
1478+
14771479
See also [`linearization_function`](@ref) which provides a lower-level interface, [`linearize_symbolic`](@ref) and [`ModelingToolkit.reorder_states`](@ref).
14781480
14791481
See extended help for an example.

0 commit comments

Comments
 (0)