namespace dome_initialization

Overview

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

namespace dome_initialization {

// global functions

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

subroutine, public dome_initialize_thickness(
    h h,
    G G,
    GV GV,
    param_file param_file,
    just_read_params just_read_params
    );

subroutine, public dome_initialize_sponges(G G, GV GV, US US, tv tv, PF PF, CSp CSp);

subroutine, public dome_set_obc_data(
    OBC OBC,
    tv tv,
    G G,
    GV GV,
    US US,
    param_file param_file,
    tr_Reg tr_Reg
    );

} // namespace dome_initialization

Detailed Documentation

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

Global Functions

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

This subroutine sets up the DOME topography.

Parameters:

g	The dynamic horizontal grid type
d	Ocean bottom depth in m or Z 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 dome_initialize_thickness(
    h h,
    G G,
    GV GV,
    param_file param_file,
    just_read_params just_read_params
    )

This subroutine initializes layer thicknesses for the DOME experiment.

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
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.
just_read_params	If present and true, this call will only read parameters without changing h.

subroutine, public dome_initialize_sponges(
    G G,
    GV GV,
    US US,
    tv tv,
    PF PF,
    CSp CSp
    )

This subroutine sets the inverse restoration time (Idamp), and ! the values towards which the interface heights and an arbitrary ! number of tracers should be restored within each sponge. The ! interface height is always subject to damping, and must always be ! the first registered field. !

Parameters:

g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
tv	A structure containing pointers to any available thermodynamic fields, including potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
pf	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.

subroutine, public dome_set_obc_data(
    OBC OBC,
    tv tv,
    G G,
    GV GV,
    US US,
    param_file param_file,
    tr_Reg 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	A structure containing pointers to any available thermodynamic fields, including potential temperature and salinity or mixed layer density. Absent fields have NULL ptrs.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
param_file	A structure indicating the open file to parse for model parameter values.
tr_reg	Tracer registry.