Skip to content

Commit 40e627e

Browse files
committed
Minor fixes to demo systems.
1 parent 4803cc8 commit 40e627e

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

src/demo_systems.jl

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@ ssrand(T::Type, n; kwargs...) = ssrand(T, n, n, 2*n; kwargs...)
2828
"""
2929
DemoSystems
3030
31-
A module containing some different systems that are commonly used as examples in the control literature.
31+
A module with standard test systems from the control literature.
3232
33-
Change the default parameter values using keyword arguments.
33+
The returned systems are of type `StateSpace` or `DelayLTISystem`.
34+
35+
Default parameter can be changed using keyword arguments.
3436
3537
SISO systems
3638
============
37-
* `DemoSystems.fo(;T=1)` First-order system `1/(sT+1)`
39+
* `DemoSystems.lag(;T=1)` First-order system `1/(sT+1)`
3840
* `DemoSystems.fotd(;T=1, τ=1)` First-order system with time delay `exp(-sτ)/(sT+1)`
3941
* `DemoSystems.sotd(;T=1, T2=10, τ=1)` Second-order non-resonant system with time delay `exp(-sτ)/(sT+1)/(sT2 + 1)`
4042
* `DemoSystems.resonant(;ω0=1, ζ=0.25)` Second-order resonant systems `ω0^2/(s^2 + 2ζ*ω0*s + ω0^2)`
@@ -53,11 +55,11 @@ using LinearAlgebra
5355

5456

5557
"""
56-
fo(;T=1, τ=1)
58+
lag(;T=1, τ=1)
5759
58-
Returns a first-order system `1/(sT+1)` (`StateSpace`).
60+
Returns a first-order system `StateSpace` with transfer function `1/(sT+1)`.
5961
"""
60-
fo(;T=1) = ss(-1/T, 1, 1/T, 0)
62+
lag(;T=1) = ss(-1/T, 1, 1/T, 0)
6163

6264

6365
"""
@@ -87,7 +89,7 @@ resonant(;ω0=1, ζ=0.25) = ss([-ζ -ω0; ω0 -ζ], [ω0; 0], [0 ω0], 0) # QUES
8789
"""
8890
`doylesat(;a=10) = ss([0 a; -a 0], I(2), [1 a; -a 1], 0)`
8991
90-
Returns a model for the spinning body (satellite) example by Doyle,
92+
Returns a `StateSpace` model for the spinning body (satellite) example by Doyle,
9193
which is a classic example that illustrates that robustness analysis of MIMO systems
9294
is more involved than for SISO systems.
9395
@@ -105,7 +107,8 @@ doylesat(;a=10) = ss([0 a; -a 0], I(2), [1 a; -a 1], 0)
105107
"""
106108
`woodberry()`
107109
108-
Returns a model for the Wood--Berry distillation column, which is a classic example from the literature on process control of MIMO process.
110+
Returns a `DelayLTISystem` model for the Wood--Berry distillation column,
111+
which is a classic example from the literature on process control of MIMO process.
109112
110113
*References:*
111114

0 commit comments

Comments
 (0)