Skip to content

Commit c8c47dd

Browse files
committed
updates docs first page [ci-skip]
1 parent 4b4dbd8 commit c8c47dd

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/src/index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,8 @@ Here's an overview of the code structure:
6666
- `barotropicqg.jl`: Defines a `BarotropicQG` module that provides
6767
several solvers for the barotropic QG model that permit beta,
6868
topography, beta + topography, and forcing.
69-
- `twomodeboussinesq.jl`: Defines a `TwoModeBoussinesq` module
70-
that provides solvers for a two-mode truncation of the
71-
rotating, stratified Boussinesq equation.
69+
- `kuramotosivashinsky.jl`: Defines a `KuramotoSivashinsky` module that
70+
solves the Kuramoto-Sivashinsky.
7271
- `traceradvdiff.jl`: Defines a `TracerAdvDiff` module that
7372
provides a solver for a two-dimensional and periodic tracer
7473
field in a given 2D flow (u, w), which can be an arbitrary
@@ -77,7 +76,7 @@ Here's an overview of the code structure:
7776
## Writing fast solvers
7877

7978
The performance-intensive part of the code involves just two functions: the
80-
timestepping scheme `stepforward!`, and the function `calcN!` that
79+
time-stepping scheme `stepforward!`, and the function `calcN!` that
8180
calculates the nonlinear part of the given equation's right-hand side.
8281
Optimization of these two functions for a given problem will produce the
8382
fastest possible code.
@@ -89,11 +88,11 @@ fastest possible code.
8988

9089
> McWilliams, J. C. (1984). The emergence of isolated coherent vortices in turbulent flow. *J. Fluid Mech.*, **146**, 21-43
9190
92-
- `examples/barotropicqg/decayingbetaturb.jl`: An example script that simulates decaying quasi-geostrophic flow on a beta-plane.
91+
- `examples/barotropicqg/decayingbetaturb.jl`: An example script that simulates decaying quasi-geostrophic flow on a beta-plane demonstrating zonation.
9392

9493
- `examples/barotropicqg/ACConelayer.jl`: A script that simulates barotropic quasi-geostrophic flow above topography reproducing the results of the paper by
9594

96-
> Constantinou, N. C. (2018). A barotropic model of eddy saturation. *J. Phys. Oceanogr.*, in press, doi:10.1175/JPO-D-17-0182.1
95+
> Constantinou, N. C. (2018). A barotropic model of eddy saturation. *J. Phys. Oceanogr.*, **48 (2)**, 397-411
9796
9897

9998

0 commit comments

Comments
 (0)