namespace benchmark_initialization

Overview

Initialization for the “bench mark” configuration. More…

namespace benchmark_initialization {

// global functions

subroutine, public benchmark_initialize_topography(D D, G G, param_file param_file, max_depth max_depth, US US);

subroutine, public benchmark_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    eqn_of_state eqn_of_state,
    P_ref P_ref,
    just_read_params just_read_params
    );

subroutine, public benchmark_init_temperature_salinity(
    T T,
    S S,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    P_Ref P_Ref,
    just_read_params just_read_params
    );

} // namespace benchmark_initialization

Detailed Documentation

Initialization for the “bench mark” configuration.

Global Functions

subroutine, public benchmark_initialize_topography(
    D D,
    G G,
    param_file param_file,
    max_depth max_depth,
    US US
    )

This subroutine sets up the benchmark test case topography.

Parameters:

g	The dynamic horizontal grid type
d	Ocean bottom depth in m or [Z ~> m] if US is present
param_file	Parameter file structure
max_depth	Maximum model depth in the units of D
us	A dimensional unit scaling type

subroutine, public benchmark_initialize_thickness(
    h h,
    G G,
    GV GV,
    US US,
    param_file param_file,
    eqn_of_state eqn_of_state,
    P_ref P_ref,
    just_read_params just_read_params
    )

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	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
h	The thickness that is being initialized [H ~> m or kg m-2].
param_file	A structure indicating the open file to parse for model parameter values.
eqn_of_state	integer that selects the equation of state.
p_ref	The coordinate-density reference pressure [Pa].
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public benchmark_init_temperature_salinity(
    T T,
    S S,
    G G,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state,
    P_Ref P_Ref,
    just_read_params just_read_params
    )

Initializes layer temperatures and salinities for benchmark.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
t	The potential temperature that is being initialized.
s	The salinity that is being initialized.
param_file	A structure indicating the open file to parse for model parameter values.
eqn_of_state	integer that selects the equation of state.
p_ref	The coordinate-density reference pressure [Pa].
just_read_params	If present and true, this call will only read parameters without changing h.