Skip to content

Commit 93428f5

Browse files
committed
docs: document the discrete_parameters
1 parent 577d20f commit 93428f5

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/src/basics/MTKLanguage.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,14 +202,15 @@ getdefault(model_c3.model_a.k_array[2])
202202

203203
- Defining continuous events as described [here](https://docs.sciml.ai/ModelingToolkit/stable/basics/Events/#Continuous-Events).
204204
- If this block is not defined in the model, no continuous events will be added.
205+
- Discrete parameters and other keyword arguments should be specified in a vector, as seen below.
205206

206207
```@example mtkmodel-example
207208
using ModelingToolkit
208209
using ModelingToolkit: t
209210
210211
@mtkmodel M begin
211212
@parameters begin
212-
k
213+
k(t)
213214
end
214215
@variables begin
215216
x(t)
@@ -222,21 +223,24 @@ using ModelingToolkit: t
222223
@continuous_events begin
223224
[x ~ 1.5] => [x ~ 5, y ~ 5]
224225
[t ~ 4] => [x ~ 10]
226+
[t ~ 5] => [k ~ 3], [discrete_parameters = k]
225227
end
226228
end
227229
```
228230

231+
229232
#### `@discrete_events` begin block
230233

231234
- Defining discrete events as described [here](https://docs.sciml.ai/ModelingToolkit/stable/basics/Events/#Discrete-events-support).
232235
- If this block is not defined in the model, no discrete events will be added.
236+
- Discrete parameters and other keyword arguments should be specified in a vector, as seen below.
233237

234238
```@example mtkmodel-example
235239
using ModelingToolkit
236240
237241
@mtkmodel M begin
238242
@parameters begin
239-
k
243+
k(t)
240244
end
241245
@variables begin
242246
x(t)
@@ -247,7 +251,8 @@ using ModelingToolkit
247251
D(y) ~ -k
248252
end
249253
@discrete_events begin
250-
(t == 1.5) => [x ~ x + 5, y ~ 5]
254+
(t == 1.5) => [x ~ Pre(x) + 5, y ~ 5]
255+
(t == 2.5) => [k ~ Pre(k) * 2], [discrete_parameters = k]
251256
end
252257
end
253258
```

0 commit comments

Comments
 (0)