More coriolis options

src/coriolis.jl

@@ -24,7 +24,7 @@ end
     FPlane([T=Float64;] f)
 
 Returns a parameter object for constant rotation at the angular frequency
-`f`, and therefore with background vorticity `2f`, around a vertical axis.
+`f/2`, and therefore with background vorticity `f`, around a vertical axis.
 
 Also called `FPlane`, after the "f-plane" approximation for the local effect of
 Earth's rotation in a planar coordinate system tangent to the Earth's surface.
@@ -34,32 +34,32 @@ function FPlane(T=Float64; f)
 end
 
 """
-    FPlane([T=Float64;] Ω, lat)
+    FPlane([T=Float64;] Ω, latitude)
 
 Returns a parameter object for constant rotation at the angular frequency
-`f = 2Ωsin(lat)`, and therefore with background vorticity `f = 4Ωsin(lat)`,
+`Ωsin(latitude), and therefore with background vorticity `f = 2Ωsin(latitude),
 around a vertical axis.
 
 Also called `FPlane`, after the "f-plane" approximation for the local effect of
 Earth's rotation in a planar coordinate system tangent to the Earth's surface.
 """
-function FPlane(T=Float64; Ω, lat)
-    return FPlane{T}(2*Ω*sind(lat))
+function FPlane(T=Float64; Ω, latitude)
+    return FPlane{T}(2*Ω*sind(latitude))
 end
 
 
 """
-    βPlane{T} <: AbstractRotation
+    BetaPlane{T} <: AbstractRotation
 
 A parameter object for meridionally increasing rotation (`f = f₀ + βy`).
 """
-struct βPlane{T} <: AbstractRotation
+struct BetaPlane{T} <: AbstractRotation
     f₀ :: T
     β  :: T
 end
 
-function βPlane(T=Float64; f₀, β)
-    return βPlane{T}(f₀, β)
+function BetaPlane(T=Float64; f₀, β)
+    return BetaPlane{T}(f₀, β)
 end
 
 @inline fv(i, j, k, grid::RegularCartesianGrid{T}, f, v) where T =
@@ -69,14 +69,16 @@ end
     T(0.5) * f * (avgx_f2c(grid, u, i,  j-1, k) + avgx_f2c(grid, u, i, j, k))
 
 @inline fv(i, j, k, grid::RegularCartesianGrid{T}, f₀, β, v) where T =
-    T(0.5) * (f₀ + β * grid.yC[j]) * (avgy_f2c(grid, v, i-1,  j, k) + avgy_f2c(grid, v, i, j, k))
+     T(0.5) * (f₀ + β * @inbounds(grid.yC[j])) * (avgy_f2c(grid, v, i-1,  j, k) + avgy_f2c(grid, v, i, j, k))
 
 @inline fu(i, j, k, grid::RegularCartesianGrid{T}, f₀, β, u) where T =
-    T(0.5) * (f₀ + β * grid.yF[j]) * (avgx_f2c(grid, u, i,  j-1, k) + avgx_f2c(grid, u, i, j, k))
+     T(0.5) * (f₀ + β * @inbounds(grid.yF[j])) * (avgx_f2c(grid, u, i,  j-1, k) + avgx_f2c(grid, u, i, j, k))
 
 @inline x_f_cross_U(i, j, k, grid, rotation::FPlane, U) = -fv(i, j, k, grid, rotation.f, U.v)
 @inline y_f_cross_U(i, j, k, grid, rotation::FPlane, U) =  fu(i, j, k, grid, rotation.f, U.u)
-@inline x_f_cross_U(i, j, k, grid, rotation::βPlane, U) = -fv(i, j, k, grid, rotation.f, rotation.β, U.v)
-@inline y_f_cross_U(i, j, k, grid, rotation::βPlane, U) =  fu(i, j, k, grid, rotation.f, rotation.β, U.u)
+
+@inline x_f_cross_U(i, j, k, grid, rotation::BetaPlane, U) = -fv(i, j, k, grid, rotation.f, rotation.β, U.v)
+@inline y_f_cross_U(i, j, k, grid, rotation::BetaPlane, U) =  fu(i, j, k, grid, rotation.f, rotation.β, U.u)
+
 @inline z_f_cross_U(i, j, k, grid::AbstractGrid{T}, ::FPlane, U) where T = zero(T)