normalization in energy() docstring

FourierFlows · Nov 22, 2020 · 5b270f6 · 5b270f6 · liasiegelman · Nov 23, 2020
1 parent b165e17
commit 5b270f6
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/src/barotropicqg.jl b/src/barotropicqg.jl
@@ -331,7 +331,7 @@ set_U!(prob, U::Float64) = set_U!(prob.sol, prob.vars, prob.params, prob.grid, U
     energy(prob)
     energy(sol, grid)
 
-Returns the domain-averaged kinetic energy of solution `sol`: ∫ ½ (u²+v²) dxdy / (Lx Ly) = ∑ ½ k² |ψ̂|².
+Returns the domain-averaged kinetic energy of solution `sol`: ∫ ½ (u²+v²) dxdy / (Lx Ly) = ∑ ½ k² |ψ̂|² / (Lx Ly).
 """
 energy(sol, grid) = parsevalsum2(sqrt.(grid.Krsq) .* grid.invKrsq .* sol, grid) / (2 * grid.Lx * grid.Ly)
 energy(prob) = energy(prob.sol, prob.grid)