Skip to content

Commit

Permalink
docs and changelog updated
Browse files Browse the repository at this point in the history
  • Loading branch information
milankl committed Oct 25, 2024
1 parent d156eda commit aba5a2b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Unreleased

- Output both accumulated and precipitation rate as netCDF [#596](https://github.com/SpeedyWeather/SpeedyWeather.jl/pull/596)
- Random processes for random pattern generation [#592](https://github.com/SpeedyWeather/SpeedyWeather.jl/pull/592)
- Also allow SpectralGrid as positional argument to model constructors [#593](https://github.com/SpeedyWeather/SpeedyWeather.jl/pull/593)
- De-interweave SpectralTransform [#587](https://github.com/SpeedyWeather/SpeedyWeather.jl/pull/587)
Expand Down
13 changes: 6 additions & 7 deletions docs/src/examples_3D.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,12 +244,11 @@ nothing # hide
![Large-scale precipitation](large-scale_precipitation_acc.png)

Precipitation (both large-scale and convective) are written into the
`simulation.diagnostic_variables.surface` which, however, accumulate all precipitation
until netCDF output is written. As we didn't specify `output=true` here, they accumulated
precipitation over the last 10 days of the simulation which includes the initial
adjustment of humidity in the tropics (the large band of precipitation here).
So let us reset these accumulators and integrate for another 6 hours to get the
precipitation only in the period.
`simulation.diagnostic_variables.physics` which, however, accumulate all precipitation
during simulation. In the NetCDF output, precipitation rate (in mm/hr) is calculated
from accumulated precipitation as a post-processing step.
More interactively, you can also reset these accumulators and integrate for another 6 hours
to get the precipitation only in that period.

```@example precipitation
# reset accumulators and simulate 6 hours
Expand All @@ -269,7 +268,7 @@ nothing # hide
![Convective precipitation](convective_precipitation.png)

As the precipitation fields are accumulated meters over the integration period
(in the case of no output) we divide by 6 hours to get a precipitation rate ``[m/s]``
we divide by 6 hours to get a precipitation rate ``[m/s]``
but then multiply with 1 hour and 1000 to get the typical precipitation unit of ``[mm/hr]``.

## References
Expand Down

0 comments on commit aba5a2b

Please sign in to comment.