shelfwave_initialization module reference

Configures the model for the idealized shelfwave test case.

More…

Data Types

shelfwave_obc_cs

Control structure for shelfwave open boundaries.

Functions/Subroutines

register_shelfwave_obc()	Add shelfwave to OBC registry.
shelfwave_obc_end()	Clean up the shelfwave OBC from registry.
shelfwave_initialize_topography()	Initialization of topography.
shelfwave_set_obc_data()	This subroutine sets the properties of flow at open boundary conditions.

Detailed Description

Configures the model for the idealized shelfwave test case.

Type Documentation

type shelfwave_initialization/shelfwave_obc_cs

Control structure for shelfwave open boundaries.

Type fields:

• % my_amp [real] :: Amplitude of the open boundary current inflows [L T-1 ~> m s-1].

• % lx [real] :: Long-shore length scale of bathymetry [km] or [m].

• % ly [real] :: Cross-shore length scale [km] or [m].

• % f0 [real] :: Coriolis parameter [T-1 ~> s-1].

• % jj [real] :: Cross-shore wave mode [nondim].

• % kk [real] :: Cross-shore wavenumber [km-1] or [m-1].

• % ll [real] :: Longshore wavenumber [km-1] or [m-1].

• % alpha [real] :: Exponential decay rate in the y-direction [km-1] or [m-1].

• % omega [real] :: Frequency of the shelf wave [T-1 ~> s-1].

Function/Subroutine Documentation

function shelfwave_initialization/register_shelfwave_obc(param_file, CS, G, US, OBC_Reg) [logical]

Add shelfwave to OBC registry.

Parameters:

• param_file :: [in] parameter file.

• cs :: shelfwave control structure.

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

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

• obc_reg :: Open boundary condition registry.

Call to:

mdl mom_error_handler::mom_error

subroutine shelfwave_initialization/shelfwave_obc_end(CS)

Clean up the shelfwave OBC from registry.

Parameters:

cs :: shelfwave control structure.

subroutine shelfwave_initialization/shelfwave_initialize_topography(D, G, param_file, max_depth, US)

Initialization of 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:

mdl

Called from:

mom_fixed_initialization::mom_initialize_topography

subroutine shelfwave_initialization/shelfwave_set_obc_data(OBC, CS, G, GV, US, h, Time)

This subroutine sets the properties of flow at open boundary conditions.

Parameters:

• obc :: This open boundary condition type specifies whether, where, and what open boundary conditions are used.

• cs :: tidal bay control structure.

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

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

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

• h :: [in] layer thickness [H ~> m or kg m-2]

• time :: [in] model time.