You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/index.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,9 +66,8 @@ Here's an overview of the code structure:
66
66
-`barotropicqg.jl`: Defines a `BarotropicQG` module that provides
67
67
several solvers for the barotropic QG model that permit beta,
68
68
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.
72
71
-`traceradvdiff.jl`: Defines a `TracerAdvDiff` module that
73
72
provides a solver for a two-dimensional and periodic tracer
74
73
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:
77
76
## Writing fast solvers
78
77
79
78
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
81
80
calculates the nonlinear part of the given equation's right-hand side.
82
81
Optimization of these two functions for a given problem will produce the
83
82
fastest possible code.
@@ -89,11 +88,11 @@ fastest possible code.
89
88
90
89
> McWilliams, J. C. (1984). The emergence of isolated coherent vortices in turbulent flow. *J. Fluid Mech.*, **146**, 21-43
91
90
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.
93
92
94
93
-`examples/barotropicqg/ACConelayer.jl`: A script that simulates barotropic quasi-geostrophic flow above topography reproducing the results of the paper by
95
94
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
0 commit comments