namespace bfb_initialization

Overview

Initialization of the boundary-forced-basing configuration. More…

namespace bfb_initialization {

// global functions

subroutine, public bfb_set_coord(
    Rlay Rlay,
    g_prime g_prime,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state
    );

subroutine, public bfb_initialize_sponges_southonly(
    G G,
    GV GV,
    US US,
    use_temperature use_temperature,
    tv tv,
    param_file param_file,
    CSp CSp,
    h h
    );

} // namespace bfb_initialization

Detailed Documentation

Initialization of the boundary-forced-basing configuration.

Global Functions

subroutine, public bfb_set_coord(
    Rlay Rlay,
    g_prime g_prime,
    GV GV,
    param_file param_file,
    eqn_of_state eqn_of_state
    )

This subroutine specifies the vertical coordinate in terms of temperature at the surface and at the bottom. This case is set up in such a way that the temperature of the topmost layer is equal to the SST at the southern edge of the domain. The temperatures are then converted to densities of the top and bottom layers and linearly interpolated for the intermediate layers.

Parameters:

rlay	Layer potential density.
g_prime	The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].
gv	The ocean’s vertical grid structure
param_file	A structure to parse for run-time parameters
eqn_of_state	Integer that selects the equation of state.

subroutine, public bfb_initialize_sponges_southonly(
    G G,
    GV GV,
    US US,
    use_temperature use_temperature,
    tv tv,
    param_file param_file,
    CSp CSp,
    h h
    )

This subroutine sets up the sponges for the southern bouundary of the domain. Maximum damping occurs within 2 degrees lat of the boundary. The damping linearly decreases northward over the next 2 degrees.

Parameters:

g	The ocean’s grid structure
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
use_temperature	If true, temperature and salinity are used as state variables.
tv	A structure pointing to various thermodynamic variables
param_file	A structure to parse for run-time parameters
csp	A pointer to the sponge control structure
h	Layer thicknesses [H ~> m or kg m-2]