baroclinic_zone_initialization module reference¶
Initial conditions for an idealized baroclinic zone.
Functions/Subroutines¶
Reads the parameters unique to this module. |
|
Initialization of temperature and salinity with the baroclinic zone initial conditions. |
Detailed Description¶
Description of the baroclinic zone initial conditions¶
yada yada yada
Function/Subroutine Documentation¶
-
subroutine
baroclinic_zone_initialization/
bcz_params
(G, GV, US, param_file, S_ref, dSdz, delta_S, dSdx, T_ref, dTdz, delta_T, dTdx, L_zone, just_read)¶ Reads the parameters unique to this module.
- Parameters:
g :: [in] Grid structure
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
param_file :: [in] Parameter file handle
s_ref :: [out] Reference salinity [S ~> ppt]
dsdz :: [out] Salinity stratification [S Z-1 ~> ppt m-1]
delta_s :: [out] Salinity difference across baroclinic zone [S ~> ppt]
dsdx :: [out] Linear salinity gradient, often in [S km-1 ~> ppt km-1] or [S degrees_E-1 ~> ppt degrees_E-1], depending on the value of Gx_axis_units
t_ref :: [out] Reference temperature [C ~> degC]
dtdz :: [out] Temperature stratification [C Z-1 ~> degC m-1]
delta_t :: [out] Temperature difference across baroclinic zone [C ~> degC]
dtdx :: [out] Linear temperature gradient, often in [C km-1 ~> degC km-1] or [C degrees_E-1 ~> degC degrees_E-1], depending on the value of Gx_axis_units
l_zone :: [out] Width of baroclinic zone, often in [km] or [degrees_N], depending on the value of Gy_axis_units
just_read :: [in] If true, this call will only read parameters without changing h.
- Call to:
mom_file_parser::closeparameterblock
mdl
mom_file_parser::openparameterblock
- Called from:
-
subroutine
baroclinic_zone_initialization/
baroclinic_zone_init_temperature_salinity
(T, S, h, depth_tot, G, GV, US, param_file, just_read)¶ Initialization of temperature and salinity with the baroclinic zone initial conditions.
- Parameters:
g :: [in] Grid structure
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
t :: [out] Potential temperature [C ~> degC]
s :: [out] Salinity [S ~> ppt]
h :: [in] The model thicknesses [Z ~> m]
depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]
param_file :: [in] A structure indicating the open file to parse for model parameter values.
just_read :: [in] If true, this call will only read parameters without changing T & S.
- Call to:
- Called from: