Skip to content

Commit ec42446

Browse files
committed
docs
1 parent b85ddd7 commit ec42446

File tree

6 files changed

+45
-13
lines changed

6 files changed

+45
-13
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,16 @@ Check out the [`examples/`](https://github.com/Adirondax/adirondax/tree/main/exa
6060

6161
<p align="center">
6262
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/kelvin_helmholtz">
63-
<img src="examples/kelvin_helmholtz/movie.gif" alt="kelvin_helmholtz" width="128"/>
63+
<img src="examples/kelvin_helmholtz/movie.gif" alt="kelvin_helmholtz" height="128"/>
6464
</a>
6565
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/logo_inverse_problem">
66-
<img src="examples/logo_inverse_problem/movie.gif" alt="logo_inverse_problem" width="128"/>
66+
<img src="examples/logo_inverse_problem/movie.gif" alt="logo_inverse_problem" height="128"/>
6767
</a>
6868
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/orszag_tang">
69-
<img src="examples/orszag_tang/movie.gif" alt="orszag_tang" width="128"/>
69+
<img src="examples/orszag_tang/movie.gif" alt="orszag_tang" height="128"/>
70+
</a>
71+
<a href="https://github.com/Adirondax/adirondax/tree/main/examples/rayleigh_taylor">
72+
<img src="examples/rayleigh_taylor/movie.gif" alt="orszag_tang" height="128"/>
7073
</a>
7174
<br>
7275
</p>

docs/pages/examples.rst

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,39 @@ Gallery
88
-------
99

1010
.. list-table::
11-
:widths: 32 32 32
11+
:widths: 25 25 25 25
1212
:header-rows: 0
1313

1414
* - .. figure:: ../../examples/kelvin_helmholtz/movie.gif
15-
:width: 300px
15+
:height: 200px
1616
:align: center
1717
:alt: kelvin_helmholtz
1818
:target: examples.html#kelvin-helmholtz
1919

2020
- .. figure:: ../../examples/logo_inverse_problem/movie.gif
21-
:width: 300px
21+
:height: 200px
2222
:align: center
2323
:alt: logo_inverse_problem
2424
:target: examples.html#logo-inverse-problem
2525

2626
- .. figure:: ../../examples/orszag_tang/movie.gif
27-
:width: 300px
27+
:height: 200px
2828
:align: center
2929
:alt: orszag_tang
3030
:target: examples.html#orszag-tang
3131

32+
- .. figure:: ../../examples/rayleigh_taylor/movie.gif
33+
:height: 200px
34+
:align: center
35+
:alt: rayleigh_taylor
36+
:target: examples.html#rayleigh-taylor
37+
3238

3339
kelvin_helmholtz
3440
----------------
3541

3642
.. figure:: ../../examples/kelvin_helmholtz/movie.gif
37-
:width: 300px
43+
:height: 300px
3844
:align: center
3945
:alt: kelvin_helmholtz
4046
:target: examples.html#kelvin-helmholtz
@@ -56,7 +62,7 @@ logo_inverse_problem
5662
--------------------
5763

5864
.. figure:: ../../examples/logo_inverse_problem/movie.gif
59-
:width: 300px
65+
:height: 300px
6066
:align: center
6167
:alt: logo_inverse_problem
6268
:target: examples.html#logo-inverse-problem
@@ -78,7 +84,7 @@ orszag_tang
7884
-----------
7985

8086
.. figure:: ../../examples/orszag_tang/movie.gif
81-
:width: 300px
87+
:height: 300px
8288
:align: center
8389
:alt: orszag_tang
8490
:target: examples.html#kelvin-helmholtz
@@ -94,3 +100,26 @@ Script:
94100

95101
.. literalinclude:: ../../examples/orszag_tang/orszag_tang.py
96102
:language: python
103+
104+
105+
rayleigh_taylor
106+
---------------
107+
108+
.. figure:: ../../examples/rayleigh_taylor/movie.gif
109+
:height: 300px
110+
:align: center
111+
:alt: rayleigh_taylor
112+
:target: examples.html#rayleigh-taylor
113+
114+
See on GitHub: `examples/rayleigh_taylor <https://github.com/AdirondaxProject/adirondax/tree/main/examples/rayleigh_taylor>`_
115+
116+
README:
117+
118+
.. literalinclude:: ../../examples/rayleigh_taylor/README.md
119+
:language: md
120+
121+
Script:
122+
123+
.. literalinclude:: ../../examples/rayleigh_taylor/rayleigh_taylor.py
124+
:language: python
125+

examples/rayleigh_taylor/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Usage:
1010
python rayleigh_taylor.py
1111
```
1212

13-
Takes around 7 seconds to run on my macbook (cpu).
13+
Takes around 9 seconds to run on my macbook (cpu).
1414

1515

1616
## Simulation snapshots

examples/rayleigh_taylor/movie.gif

197 KB
Loading
-145 Bytes
Loading

examples/rayleigh_taylor/rayleigh_taylor.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ def set_up_simulation():
2020
# Define the parameters for the simulation
2121
nx = 64
2222
ny = 192
23-
nt = 10000 # -1
24-
t_stop = 15.0
23+
nt = 13000 # -1
24+
t_stop = 20.0
2525

2626
params = {
2727
"physics": {

0 commit comments

Comments
 (0)