benchmark_initialization module reference¶

Initialization for the “bench mark” configuration.

Functions/Subroutines¶

`benchmark_initialize_topography()`	This subroutine sets up the benchmark test case topography.
`benchmark_initialize_thickness()`	Initializes layer thicknesses for the benchmark test case, by finding the depths of interfaces in a specified latitude-dependent temperature profile with an exponentially decaying thermocline on top of a linear stratification.
`benchmark_init_temperature_salinity()`	Initializes layer temperatures and salinities for benchmark.

Detailed Description¶

Initialization for the “bench mark” configuration.

Function/Subroutine Documentation¶

subroutine benchmark_initialization/benchmark_initialize_topography(D, G, param_file, max_depth, US)¶

This subroutine sets up the benchmark test case topography.

Parameters:

g :: [in] The dynamic horizontal grid type
d :: [out] Ocean bottom depth [Z ~> m]
param_file :: [in] Parameter file structure
max_depth :: [in] Maximum model depth [Z ~> m]
us :: [in] A dimensional unit scaling type

Call to:

mom_error_handler::mom_mesg

Called from:

mom_fixed_initialization::mom_initialize_topography

subroutine benchmark_initialization/benchmark_initialize_thickness(h, depth_tot, G, GV, US, param_file, eqn_of_state, P_Ref, just_read)¶

Initializes layer thicknesses for the benchmark test case, by finding the depths of interfaces in a specified latitude-dependent temperature profile with an exponentially decaying thermocline on top of a linear stratification.

Parameters:

g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
h :: [out] The thickness that is being initialized [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.
eqn_of_state :: [in] Equation of state structure
p_ref :: [in] The coordinate-density reference pressure [R L2 T-2 ~> Pa].
just_read :: [in] If true, this call will only read parameters without changing h.

Call to:

mom_error_handler::mom_mesg

subroutine benchmark_initialization/benchmark_init_temperature_salinity(T, S, G, GV, US, param_file, eqn_of_state, P_Ref, just_read)¶

Initializes layer temperatures and salinities for benchmark.

Parameters:

g :: [in] The ocean’s grid structure
gv :: [in] The ocean’s vertical grid structure
t :: [out] The potential temperature that is being initialized [C ~> degC]
s :: [out] The salinity that is being initialized [S ~> ppt]
us :: [in] A dimensional unit scaling type
param_file :: [in] A structure indicating the open file to parse for model parameter values.
eqn_of_state :: [in] Equation of state structure
p_ref :: [in] The coordinate-density reference pressure [R L2 T-2 ~> Pa]
just_read :: [in] If true, this call will only read parameters without changing T & S.

Called from:

mom_state_initialization::mom_initialize_state