# bfb_initialization module reference¶

Initialization of the boundary-forced-basing configuration.

More…

## Functions/Subroutines¶

 bfb_set_coord() This subroutine specifies the vertical coordinate in terms of temperature at the surface and at the bottom. bfb_initialize_sponges_southonly() This subroutine sets up the sponges for the southern bouundary of the domain. write_bfb_log() Write output about the parameter values being used.

## Detailed Description¶

Initialization of the boundary-forced-basing configuration.

## Function/Subroutine Documentation¶

subroutine bfb_initialization/bfb_set_coord(Rlay, g_prime, GV, US, param_file, 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
• gv :: [in] The ocean’s vertical grid structure

• rlay :: [out] Layer potential density [R ~> kg m-3].

• g_prime :: [out] The reduced gravity at each interface [L2 Z-1 T-2 ~> m s-2].

• us :: [in] A dimensional unit scaling type

• param_file :: [in] A structure to parse for run-time parameters

• eqn_of_state :: Equation of state structure

Call to

first_call write_bfb_log

Called from

mom_coord_initialization::mom_initialize_coord

subroutine bfb_initialization/bfb_initialize_sponges_southonly(G, GV, US, use_temperature, tv, depth_tot, param_file, CSp, 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 :: [in] The ocean’s grid structure

• gv :: [in] The ocean’s vertical grid structure.

• us :: [in] A dimensional unit scaling type

• use_temperature :: [in] If true, temperature and salinity are used as state variables.

• tv :: [in] A structure pointing to various thermodynamic variables

• depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]

• param_file :: [in] A structure to parse for run-time parameters

• csp :: A pointer to the sponge control structure

• h :: [in] Layer thicknesses [H ~> m or kg m-2]

Call to

first_call mom_sponge::initialize_sponge write_bfb_log

Called from

mom_state_initialization::mom_initialize_state

subroutine bfb_initialization/write_bfb_log(param_file)

Write output about the parameter values being used.

Parameters

param_file :: [in] A structure indicating the open file to parse for model parameter values.

Call to

first_call

Called from