Skip to content

Commit 36f2019

Browse files
authored
Minor language fixes in resonant-circuit
1 parent 33f1dcb commit 36f2019

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

resonant-circuit/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ summary: We simulate a two-element LC circuit (one inductor and one capacitor).
77

88
## Setup
99

10-
The purpose of this tutorial is to illustrate the usage of preCICE to couple MATLAB code. Two different MATLAB solvers will be coupled to simulate a two-element LC circuit. This type of circuit consists on a very simple system with one inductor and one capacitor:
10+
The purpose of this tutorial is to illustrate the usage of preCICE to couple MATLAB code. Two different MATLAB solvers will be coupled to simulate a two-element LC circuit. This type of circuit consists of a very simple system with one inductor and one capacitor:
1111

1212
![LC circuit diagram [1]](images/tutorials-resonant-circuit-diagram.svg)
1313

@@ -17,9 +17,9 @@ $U(t) = L \frac{\text{d}I}{\text{d}t}$
1717

1818
$I(t) = -C \frac{\text{d}U}{\text{d}t}$
1919

20-
where $I$ is the current and $U$ the voltage of the cirucit.
20+
where $I$ is the current and $U$ the voltage of the circuit.
2121

22-
Each of these equations is going to be solved by a different MATLAB solver. Note that as only one scalar is solved per equation, this is a 0+1 dimensional problem.
22+
Each of these equations is going to be solved by a different MATLAB solver. Note that, as only one scalar is solved per equation, this is a 0+1 dimensional problem.
2323

2424
## Configuration
2525

@@ -36,23 +36,23 @@ preCICE configuration (image generated using the [precice-config-visualizer](htt
3636

3737
### MATLAB
3838

39-
For running this example, first get into one of folders with the solvers and open a MATLAB instance.
39+
For running this example, first get into one of the solver folders and open a MATLAB instance.
4040
Afterward, do the same for the second solver.
4141
After adding the MATLAB bindings to the MATLAB path (in both instances), run the following commands:
4242

43-
In the first MATLAB instance one can run the solver for the current:
43+
In the first MATLAB instance, one can run the solver for the current:
4444

4545
```MATLAB
4646
coil
4747
```
4848

49-
And in the second MATLAB instance the solver for the voltage:
49+
And in the second MATLAB instance, the solver for the voltage:
5050

5151
```MATLAB
5252
capacitor
5353
```
5454

55-
The preCICE configuration file is available as `precice-config.xml`, and it is called directly in the solvers.
55+
The preCICE configuration file is hard-coded as `precice-config.xml` in the solvers.
5656

5757
#### Running from terminal
5858

@@ -67,7 +67,7 @@ The solver for the current also records the current and voltage through time and
6767

6868
After successfully running the coupling, one can find the curves in the folder `capacitor-matlab` as `Curves.png`.
6969

70-
The `Curves.png` plot could exemplarily look like the following:
70+
Example of a `Curves.png` plot:
7171
![Voltage and current plot of the resonant circuit](images/tutorials-resonant-circuit-curves.png)
7272

7373
## References

0 commit comments

Comments
 (0)