namespace mom_isopycnal_slopes

Overview

Calculations of isoneutral slopes and stratification. More…

namespace mom_isopycnal_slopes {

// global functions

subroutine, public calc_isoneutral_slopes(
    G G,
    GV GV,
    US US,
    h h,
    e e,
    tv tv,
    dt_kappa_smooth dt_kappa_smooth,
    slope_x slope_x,
    slope_y slope_y,
    N2_u N2_u,
    N2_v N2_v,
    halo halo
    );

subroutine, public vert_fill_ts(
    h h,
    T_in T_in,
    S_in S_in,
    kappa_dt kappa_dt,
    T_f T_f,
    S_f S_f,
    G G,
    GV GV,
    halo_here halo_here,
    larger_h_denom larger_h_denom
    );

} // namespace mom_isopycnal_slopes

Detailed Documentation

Calculations of isoneutral slopes and stratification.

Global Functions

subroutine, public calc_isoneutral_slopes(
    G G,
    GV GV,
    US US,
    h h,
    e e,
    tv tv,
    dt_kappa_smooth dt_kappa_smooth,
    slope_x slope_x,
    slope_y slope_y,
    N2_u N2_u,
    N2_v N2_v,
    halo halo
    )

Calculate isopycnal slopes, and optionally return N2 used in calculation.

Parameters:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
us	A dimensional unit scaling type
h	Layer thicknesses [H ~> m or kg m-2]
e	Interface heights [Z ~> m] or units given by 1/eta_to_m)
tv	A structure pointing to various thermodynamic variables
dt_kappa_smooth	A smoothing vertical diffusivity times a smoothing timescale [Z2 ~> m2].
slope_x	Isopycnal slope in i-direction [nondim]
slope_y	Isopycnal slope in j-direction [nondim]
n2_u	Brunt-Vaisala frequency squared at
n2_v	Brunt-Vaisala frequency squared at
halo	Halo width over which to compute

subroutine, public vert_fill_ts(
    h h,
    T_in T_in,
    S_in S_in,
    kappa_dt kappa_dt,
    T_f T_f,
    S_f S_f,
    G G,
    GV GV,
    halo_here halo_here,
    larger_h_denom larger_h_denom
    )

Returns tracer arrays (nominally T and S) with massless layers filled with sensible values, by diffusing vertically with a small but constant diffusivity.

Parameters:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure
h	Layer thicknesses [H ~> m or kg m-2]
t_in	Input temperature [degC]
s_in	Input salinity [ppt]
kappa_dt	A vertical diffusivity to use for smoothing times a smoothing timescale [Z2 ~> m2].
t_f	Filled temperature [degC]
s_f	Filled salinity [ppt]
halo_here	Number of halo points to work on, 0 by default
larger_h_denom	Present and true, add a large enough minimal thickness in the denominator of the flux calculations so that the fluxes are never so large as eliminate the transmission of information across groups of massless layers.