Skip to content

Commit 5fb8291

Browse files
committed
docs: use new time series names
1 parent 2a273bd commit 5fb8291

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/cookbook/nura.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ for folder in pwd.glob('ra-*'):
2828
# get the value of the Rayleigh number
2929
ran.append(sdat.par.nml['refstate']['ra0'])
3030
# get the last value of the Nusselt number
31-
nun.append(sdat.tseries['Nutop'].values[-1])
31+
nun.append(sdat.tseries['Nu_top'].values[-1])
3232

3333
ran = np.array(ran)
3434
nun = np.array(nun)

docs/cookbook/time.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ The command
1212
stagpy time
1313
```
1414

15-
will give you by default one figure with two subplots. The first subplot
15+
will give you by default one figure with three subplots. The first subplot
1616
contains the time series of the Nusselt number at the top and bottom
17-
boundaries, with a check of the energy balance. The corresponding line should
18-
be zero at all times for a perfect balance. The second subplot contains the
19-
time series of the mean temperature. This is equivalent to typing
17+
boundaries. The second subplot contains the time series of the rms velocity.
18+
The third subplot is the time series of the mean temperature. This is
19+
equivalent to typing
2020

2121
```sh title="shell"
22-
stagpy time -o Nubot,Nutop,ebalance.vrms
22+
stagpy time -o Nu_top,Nu_bot.Vrms.Tmean
2323
```
2424

2525
The command
@@ -32,7 +32,7 @@ will give you the same plots but starting at time 0.02 and ending at
3232
time 0.03.
3333

3434
```sh title="shell"
35-
stagpy time -o vrms-Tmin,Tmean,Tmax.dTdt
35+
stagpy time -o Vrms-Tmin,Tmean,Tmax.dTdt
3636
```
3737

3838
creates two figures. The first one contains the time series of the rms

docs/cookbook/vrmsra.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ for folder in pwd.glob('ra-*'):
2323
# Reference Rayleigh number as a power of ten
2424
ra0_log10 = int(np.log10(sdat.par.nml['refstate']['ra0']))
2525
# vrms time series object
26-
vrms = sdat.tseries['vrms']
26+
vrms = sdat.tseries['Vrms']
2727
# plot time vs vrms values
2828
plt.plot(vrms.time, vrms.values, label=f'$Ra=10^{{{ra0_log10}}}$')
2929

0 commit comments

Comments
 (0)