Skip to content

Commit a62167c

Browse files
committed
Update more documentation
1 parent 31e7c6c commit a62167c

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

docs/src/basics/Validation.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,19 @@ Units may be assigned with the following syntax.
88

99
```@example validation
1010
using ModelingToolkit, DynamicQuantities
11-
@variables t [unit = u"s"] x(t) [unit = u"m"] g(t) w(t) [unit = "Hz"]
11+
@parameters t [unit = u"s"]
12+
@variables x(t) [unit = u"m"] g(t) w(t) [unit = u"Hz"]
1213
13-
@variables(t, [unit = u"s"], x(t), [unit = u"m"], g(t), w(t), [unit = "Hz"])
14+
@parameters(t, [unit = u"s"])
15+
@variables(x(t), [unit = u"m"], g(t), w(t), [unit = u"Hz"])
1416
17+
@parameters begin
18+
t, [unit = u"s"]
19+
end
1520
@variables(begin
16-
t, [unit = u"s"],
1721
x(t), [unit = u"m"],
1822
g(t),
19-
w(t), [unit = "Hz"]
23+
w(t), [unit = u"Hz"]
2024
end)
2125
2226
# Simultaneously set default value (use plain numbers, not quantities)
@@ -46,10 +50,10 @@ Example usage below. Note that `ModelingToolkit` does not force unit conversions
4650

4751
```@example validation
4852
using ModelingToolkit, DynamicQuantities
49-
@parameters τ [unit = u"ms"]
50-
@variables t [unit = u"ms"] E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
53+
@parameters t [unit = u"ms"] τ [unit = u"ms"]
54+
@variables E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
5155
D = Differential(t)
52-
eqs = eqs = [D(E) ~ P - E / τ,
56+
eqs = [D(E) ~ P - E / τ,
5357
0 ~ P]
5458
ModelingToolkit.validate(eqs)
5559
```
@@ -70,10 +74,10 @@ An example of an inconsistent system: at present, `ModelingToolkit` requires tha
7074

7175
```@example validation
7276
using ModelingToolkit, DynamicQuantities
73-
@parameters τ [unit = u"ms"]
74-
@variables t [unit = u"ms"] E(t) [unit = u"J"] P(t) [unit = u"MW"]
77+
@parameters t [unit = u"ms"] τ [unit = u"ms"]
78+
@variables E(t) [unit = u"J"] P(t) [unit = u"MW"]
7579
D = Differential(t)
76-
eqs = eqs = [D(E) ~ P - E / τ,
80+
eqs = [D(E) ~ P - E / τ,
7781
0 ~ P]
7882
ModelingToolkit.validate(eqs) #Returns false while displaying a warning message
7983
```
@@ -115,7 +119,8 @@ In order for a function to work correctly during both validation & execution, th
115119

116120
```julia
117121
using ModelingToolkit, DynamicQuantities
118-
@variables t [unit = u"ms"] E(t) [unit = u"J"] P(t) [unit = u"MW"]
122+
@parameters t [unit = u"ms"]
123+
@variables E(t) [unit = u"J"] P(t) [unit = u"MW"]
119124
D = Differential(t)
120125
eqs = [D(E) ~ P - E / 1u"ms"]
121126
ModelingToolkit.validate(eqs) #Returns false while displaying a warning message
@@ -129,8 +134,8 @@ Instead, they should be parameterized:
129134

130135
```@example validation3
131136
using ModelingToolkit, DynamicQuantities
132-
@parameters τ [unit = u"ms"]
133-
@variables t [unit = u"ms"] E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
137+
@parameters t [unit = u"ms"] τ [unit = u"ms"]
138+
@variables E(t) [unit = u"kJ"] P(t) [unit = u"MW"]
134139
D = Differential(t)
135140
eqs = [D(E) ~ P - E / τ]
136141
ModelingToolkit.validate(eqs) #Returns true

src/utils.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,8 @@ collect_differential_variables(sys) = collect_operator_variables(sys, Differenti
418418
Return a `Set` with all applied operators in `x`, example:
419419
420420
```
421-
@variables t u(t) y(t)
421+
@parameters t
422+
@variables u(t) y(t)
422423
D = Differential(t)
423424
eq = D(y) ~ u
424425
ModelingToolkit.collect_applied_operators(eq, Differential) == Set([D(y)])

0 commit comments

Comments
 (0)