some more minor changes

FourierFlows · Jan 28, 2021 · 375fddd · 375fddd
1 parent 56fc153
commit 375fddd
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 12 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,6 +6,7 @@
 [FourierFlows.jl](https://github.com/FourierFlows/FourierFlows.jl) framework to provide
 solvers for problems in Geophysical Fluid Dynamics, on periodic domains using Fourier-based pseudospectral methods.
 
+
 ## Examples
 
 Examples aim to demonstrate the main functionalities of each module. Have a look at our Examples collection!
@@ -53,6 +54,7 @@ The development of GeophysicalFlows.jl started by [Navid C. Constantinou](http:/
 course of time various people have contributed to GeophysicalFlows.jl, including 
 [Lia Siegelman](https://scholar.google.com/citations?user=BQJtj6sAAAAJ), [Brodie Pearson](https://brodiepearson.github.io), and [André Palóczy](https://scholar.google.com/citations?user=o4tYEH8AAAAJ) (see the [example in FourierFlows.jl](https://fourierflows.github.io/FourierFlowsDocumentation/stable/generated/OneDShallowWaterGeostrophicAdjustment/)).
 
+
 ## Cite
 
 The code is citable via [zenodo](https://doi.org/10.5281/zenodo.1463809).
diff --git a/docs/src/modules/singlelayerqg.md b/docs/src/modules/singlelayerqg.md
@@ -102,10 +102,10 @@ The total energy is:
 GeophysicalFlows.SingleLayerQG.energy
 ```
 
-Other diagnostic include: [`energy_dissipation`](@ref GeophysicalFlows.SurfaceQG.energy_dissipation), 
-[`energy_drag`](@ref GeophysicalFlows.SurfaceQG.energy_drag), [`energy_work`](@ref GeophysicalFlows.SurfaceQG.energy_work), 
-[`enstrophy_dissipation`](@ref GeophysicalFlows.SurfaceQG.enstrophy_dissipation), and
-[`enstrophy_drag`](@ref GeophysicalFlows.SurfaceQG.enstrophy_drag), [`enstrophy_work`](@ref GeophysicalFlows.SurfaceQG.enstrophy_work).
+Other diagnostic include: [`energy_dissipation`](@ref GeophysicalFlows.SingleLayerQG.energy_dissipation), 
+[`energy_drag`](@ref GeophysicalFlows.SingleLayerQG.energy_drag), [`energy_work`](@ref GeophysicalFlows.SingleLayerQG.energy_work), 
+[`enstrophy_dissipation`](@ref GeophysicalFlows.SingleLayerQG.enstrophy_dissipation), and
+[`enstrophy_drag`](@ref GeophysicalFlows.SingleLayerQG.enstrophy_drag), [`enstrophy_work`](@ref GeophysicalFlows.SingleLayerQG.enstrophy_work).
 
 
 ## Examples

diff --git a/src/twodnavierstokes.jl b/src/twodnavierstokes.jl
@@ -1,10 +1,3 @@
-"""
-A module for simulating two-dimensional incompressible fluid with the Navier-Stokes equations. 
-The module uses the vorticity-streamfunction formulation.
-
-# Exports
-$(EXPORTS)
-"""
 module TwoDNavierStokes
 
 export

diff --git a/src/utils.jl b/src/utils.jl
@@ -20,7 +20,7 @@ function lambdipole(U, R, grid::TwoDGrid{T, A}; center=(mean(grid.x), mean(grid.
 end
 
 """
-    peakedisotropicspectrum(g, kpeak, E₀; mask=mask, allones=false)
+    peakedisotropicspectrum(grid, kpeak, E₀; mask=mask, allones=false)
 
 Generate a random two-dimensional relative vorticity field ``q(x, y)`` with Fourier spectrum 
 peaked around a central non-dimensional wavenumber `kpeak` and normalized so that its total