dome_initialization module reference¶

Configures the model for the “DOME” experiment. DOME = Dynamics of Overflows and Mixing Experiment.

Functions/Subroutines¶

`dome_initialize_topography()`	This subroutine sets up the DOME topography.
`dome_initialize_thickness()`	This subroutine initializes layer thicknesses for the DOME experiment.
`dome_initialize_sponges()`	This subroutine sets the inverse restoration time (Idamp), and the values toward which the interface heights and an arbitrary number of tracers will be restored within the sponges for the DOME configuration.
`register_dome_obc()`	Add DOME to the OBC registry and set up some variables that will be used to guide code setting up the restart fields related to the OBCs.
`dome_set_obc_data()`	This subroutine sets the properties of flow at open boundary conditions.

Detailed Description¶

Configures the model for the “DOME” experiment. DOME = Dynamics of Overflows and Mixing Experiment.

Function/Subroutine Documentation¶

subroutine dome_initialization/dome_initialize_topography(D, G, param_file, max_depth, US)¶

This subroutine sets up the DOME 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 dome_initialization/dome_initialize_thickness(h, depth_tot, G, GV, param_file, just_read)¶

This subroutine initializes layer thicknesses for the DOME experiment.

Parameters:

g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
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.
just_read :: [in] If true, this call will only read parameters without changing h.

Call to:

mom_error_handler::mom_mesg

subroutine dome_initialization/dome_initialize_sponges(G, GV, US, tv, depth_tot, PF, CSp)¶

This subroutine sets the inverse restoration time (Idamp), and the values toward which the interface heights and an arbitrary number of tracers will be restored within the sponges for the DOME configuration. !

Parameters:

g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
tv :: [in] A structure containing any available thermodynamic fields, including potential temperature and salinity or mixed layer density.
depth_tot :: [in] The nominal total depth of the ocean [Z ~> m]
pf :: [in] A structure indicating the open file to parse for model parameter values.
csp :: A pointer that is set to point to the control structure for this module.

Call to:

mom_sponge::initialize_sponge mom_error_handler::mom_error mom_sponge::set_up_sponge_field

Called from:

mom_state_initialization::mom_initialize_state

subroutine dome_initialization/register_dome_obc(param_file, US, OBC, tr_Reg)¶

Add DOME to the OBC registry and set up some variables that will be used to guide code setting up the restart fields related to the OBCs.

Parameters:

param_file :: [in] parameter file.
us :: [in] A dimensional unit scaling type
obc :: OBC registry.
tr_reg :: Tracer registry.

Call to:

mom_error_handler::mom_error

Called from:

mom_boundary_update::call_obc_register

subroutine dome_initialization/dome_set_obc_data(OBC, tv, G, GV, US, PF, tr_Reg)¶

This subroutine sets the properties of flow at open boundary conditions. This particular example is for the DOME inflow describe in Legg et al. 2006.

Parameters:

obc :: This open boundary condition type specifies whether, where, and what open boundary conditions are used.
tv :: [in] A structure containing pointers to any available thermodynamic fields, including potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
us :: [in] A dimensional unit scaling type
pf :: [in] A structure indicating the open file to parse for model parameter values.
tr_reg :: Tracer registry.

Call to:

mom_error_handler::mom_error mom_open_boundary::register_segment_tracer mom_tracer_registry::tracer_name_lookup