Skip to content

Commit 31e7c6c

Browse files
committed
Update documentation
1 parent 63c2ef3 commit 31e7c6c

File tree

10 files changed

+25
-19
lines changed

10 files changed

+25
-19
lines changed

docs/src/tutorials/SampledData.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ H(z) = \dfrac{b_2 z^2 + b_1 z + b_0}{a_2 z^2 + a_1 z + a_0}
9797
may thus be modeled as
9898

9999
```julia
100-
@variables t y(t) [description = "Output"] u(t) [description = "Input"]
100+
t = ModelingToolkit.t_nounits
101+
@variables y(t) [description = "Output"] u(t) [description = "Input"]
101102
k = ShiftIndex(Clock(t, dt))
102103
eqs = [
103104
a2 * y(k) + a1 * y(k - 1) + a0 * y(k - 2) ~ b2 * u(k) + b1 * u(k - 1) + b0 * u(k - 2)

src/discretedomain.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ $(FIELDS)
9898
```jldoctest
9999
julia> using Symbolics
100100
101-
julia> @variables t;
101+
julia> t = ModelingToolkit.t_nounits
102102
103103
julia> Δ = Sample(t, 0.01)
104104
(::Sample) (generic function with 2 methods)
@@ -166,7 +166,9 @@ The `ShiftIndex` operator allows you to index a signal and obtain a shifted disc
166166
# Examples
167167
168168
```
169-
julia> @variables t x(t);
169+
julia> t = ModelingToolkit.t_nounits;
170+
171+
julia> @variables x(t);
170172
171173
julia> k = ShiftIndex(t, 0.1);
172174

src/systems/abstractsystem.jl

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2237,11 +2237,10 @@ This example builds the following feedback interconnection and linearizes it fro
22372237
22382238
```julia
22392239
using ModelingToolkit
2240-
@variables t
2240+
using ModelingToolkit: t_nounits as t, D_nounits as D
22412241
function plant(; name)
22422242
@variables x(t) = 1
22432243
@variables u(t)=0 y(t)=0
2244-
D = Differential(t)
22452244
eqs = [D(x) ~ -x + u
22462245
y ~ x]
22472246
ODESystem(eqs, t; name = name)
@@ -2250,7 +2249,6 @@ end
22502249
function ref_filt(; name)
22512250
@variables x(t)=0 y(t)=0
22522251
@variables u(t)=0 [input = true]
2253-
D = Differential(t)
22542252
eqs = [D(x) ~ -2 * x + u
22552253
y ~ x]
22562254
ODESystem(eqs, t, name = name)

src/systems/alias_elimination.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,8 +388,10 @@ Use Kahn's algorithm to topologically sort observed equations.
388388
389389
Example:
390390
```julia
391-
julia> @variables t x(t) y(t) z(t) k(t)
392-
(t, x(t), y(t), z(t), k(t))
391+
julia> t = ModelingToolkit.t_nounits
392+
393+
julia> @variables x(t) y(t) z(t) k(t)
394+
(x(t), y(t), z(t), k(t))
393395
394396
julia> eqs = [
395397
x ~ y + z

src/systems/dependency_graphs.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ Example:
1515
1616
```julia
1717
using ModelingToolkit
18+
using ModelingToolkit: t_nounits as t
1819
@parameters β γ κ η
19-
@variables t S(t) I(t) R(t)
20+
@variables S(t) I(t) R(t)
2021
2122
rate₁ = β * S * I
2223
rate₂ = γ * I + t

src/systems/diffeqs/odesystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ $(FIELDS)
1010
1111
```julia
1212
using ModelingToolkit
13+
using ModelingToolkit: t_nounits as t, D_nounits as D
1314
1415
@parameters σ ρ β
15-
@variables t x(t) y(t) z(t)
16-
D = Differential(t)
16+
@variables x(t) y(t) z(t)
1717
1818
eqs = [D(x) ~ σ*(y-x),
1919
D(y) ~ x*(ρ-z)-y,

src/systems/diffeqs/sdesystem.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ $(FIELDS)
1010
1111
```julia
1212
using ModelingToolkit
13+
using ModelingToolkit: t_nounits as t, D_nounits as D
1314
1415
@parameters σ ρ β
15-
@variables t x(t) y(t) z(t)
16-
D = Differential(t)
16+
@variables x(t) y(t) z(t)
1717
1818
eqs = [D(x) ~ σ*(y-x),
1919
D(y) ~ x*(ρ-z)-y,
@@ -321,10 +321,10 @@ experiments. Springer Science & Business Media.
321321
322322
```julia
323323
using ModelingToolkit
324+
using ModelingToolkit: t_nounits as t, D_nounits as D
324325
325326
@parameters α β
326-
@variables t x(t) y(t) z(t)
327-
D = Differential(t)
327+
@variables x(t) y(t) z(t)
328328
329329
eqs = [D(x) ~ α*x]
330330
noiseeqs = [β*x]

src/systems/jumps/jumpsystem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ $(FIELDS)
3434
3535
```julia
3636
using ModelingToolkit, JumpProcesses
37+
using ModelingToolkit: t_nounits as t
3738
3839
@parameters β γ
39-
@variables t S(t) I(t) R(t)
40+
@variables S(t) I(t) R(t)
4041
rate₁ = β*S*I
4142
affect₁ = [S ~ S - 1, I ~ I + 1]
4243
rate₂ = γ*I

src/systems/pde/pdesystem.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ $(FIELDS)
1111
```julia
1212
using ModelingToolkit
1313
14-
@parameters x
15-
@variables t u(..)
14+
@parameters x t
15+
@variables u(..)
1616
Dxx = Differential(x)^2
1717
Dtt = Differential(t)^2
1818
Dt = Differential(t)

src/utils.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,8 @@ Return a `Set` containing all variables in `x` that appear in
345345
Example:
346346
347347
```
348-
@variables t u(t) y(t)
348+
t = ModelingToolkit.t_nounits
349+
@variables u(t) y(t)
349350
D = Differential(t)
350351
v = ModelingToolkit.vars(D(y) ~ u)
351352
v == Set([D(y), u])

0 commit comments

Comments
 (0)