Skip to content

Commit 1af4d19

Browse files
docs: do not use @mtkmodel System in docs
1 parent 19b8938 commit 1af4d19

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/src/connectors/sign_convention.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ end
7979
Here we can see that a positive input force results in an increasing velocity.
8080

8181
```@example sign_convention
82-
@mtkmodel System begin
82+
@mtkmodel Model begin
8383
@components begin
8484
mass = Mass(; m = 10)
8585
force = ConstantForce(; f = 1)
@@ -88,7 +88,7 @@ Here we can see that a positive input force results in an increasing velocity.
8888
connect(mass.flange, force.flange)
8989
end
9090
end
91-
@mtkbuild sys = System()
91+
@mtkbuild sys = Model()
9292
full_equations(sys)
9393
```
9494

@@ -117,7 +117,7 @@ end
117117
Here we can see that a positive input current results in an increasing voltage. Note that the electrical domain uses pins `p` and `n` at each side of the source and energy storage components. The direction of connection is not important here, only that a positive connector `p` connects with a negative connector `n`.
118118

119119
```@example sign_convention
120-
@mtkmodel System begin
120+
@mtkmodel Model begin
121121
@components begin
122122
capacitor = Capacitor(; C = 10)
123123
current = ConstantCurrent(; i = 1)
@@ -128,14 +128,14 @@ Here we can see that a positive input current results in an increasing voltage.
128128
connect(capacitor.n, current.p, ground.g)
129129
end
130130
end
131-
@mtkbuild sys = System()
131+
@mtkbuild sys = Model()
132132
full_equations(sys)
133133
```
134134

135135
Reversing the pins gives the same result
136136

137137
```@example sign_convention
138-
@mtkmodel System begin
138+
@mtkmodel Model begin
139139
@components begin
140140
capacitor = Capacitor(; C = 10)
141141
current = ConstantCurrent(; i = 1)
@@ -146,7 +146,7 @@ Reversing the pins gives the same result
146146
connect(capacitor.p, current.n, ground.g)
147147
end
148148
end
149-
@mtkbuild sys = System()
149+
@mtkbuild sys = Model()
150150
full_equations(sys)
151151
```
152152

@@ -173,7 +173,7 @@ end
173173
A positive input mass flow leads to an increasing pressure (in this case we get increasing density (`rho`), which is directly related to an increasing pressure).
174174

175175
```@example sign_convention
176-
@mtkmodel System begin
176+
@mtkmodel Model begin
177177
@components begin
178178
volume = FixedVolume(; vol = 10.0, p_int = 1e5)
179179
flow = ConstantMassFlow(; dm = 1)
@@ -184,6 +184,6 @@ A positive input mass flow leads to an increasing pressure (in this case we get
184184
connect(fluid, flow.port)
185185
end
186186
end
187-
@mtkbuild sys = System()
187+
@mtkbuild sys = Model()
188188
full_equations(sys) |> first
189189
```

0 commit comments

Comments
 (0)