dyed_channel_initialization module reference

Initialization for the dyed_channel configuration.

Data Types

Control structure for dyed-channel open boundaries.

`register_dyed_channel_obc()`	Add dyed channel to OBC registry.
`dyed_channel_obc_end()`	Clean up the dyed_channel OBC from registry.
`dyed_channel_set_obc_tracer_data()`	This subroutine sets the dye and flow properties at open boundary conditions.
`dyed_channel_update_flow()`	This subroutine updates the long-channel flow.

Setting dyes, one for painting the inflow on each side.

type dyed_channel_initialization/dyed_channel_obc_cs

Control structure for dyed-channel open boundaries.

Type fields:

% zonal_flow :: real Mean inflow [L T-1 ~> m s-1].
% tidal_amp :: real Sloshing amplitude [L T-1 ~> m s-1].
% frequency :: real Sloshing frequency [T-1 ~> s-1].
% obc_transport_bug :: logical If true and specified open boundary conditions are being used, use a 1 m (if Boussienesq) or 1 kg m-2 layer thickness instead of the actual thickness.

function dyed_channel_initialization/register_dyed_channel_obc(param_file, CS, US, OBC_Reg)

Add dyed channel to OBC registry.

Parameters:

Call to:

subroutine dyed_channel_initialization/dyed_channel_obc_end(CS)

Clean up the dyed_channel OBC from registry.

subroutine dyed_channel_initialization/dyed_channel_set_obc_tracer_data(OBC, G, GV, param_file, tr_Reg)

This subroutine sets the dye and flow properties at open boundary conditions.

Parameters:

obc :: This open boundary condition type specifies whether, where, and what open boundary conditions are used.
g :: [in] The ocean’s grid structure.
gv :: [in] The ocean’s vertical grid structure.
param_file :: param_file [in] A structure indicating the open file to parse for model parameter values.
tr_reg :: Tracer registry.

Call to:

mom_error_handler::mom_error ntr

Called from:

mom_state_initialization::mom_initialize_obcs

subroutine dyed_channel_initialization/dyed_channel_update_flow(OBC, CS, G, GV, US, h, Time)

This subroutine updates the long-channel flow.

Parameters:

obc :: This open boundary condition type specifies whether, where, and what open boundary conditions are used.
cs :: Dyed channel 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 :: h [in] layer thickness [H ~> m or kg m-2]
time :: [in] model time.

Call to:

mom_error_handler::mom_error