namespace dyed_channel_initialization

Overview

Initialization for the dyed_channel configuration. More…

namespace dyed_channel_initialization {

// global variables

integer ntr = 0;

// global functions

logical function, public register_dyed_channel_obc(param_file param_file, CS CS, OBC_Reg OBC_Reg);
subroutine, public dyed_channel_obc_end(CS CS);
subroutine, public dyed_channel_set_obc_tracer_data(OBC OBC, G G, GV GV, param_file param_file, tr_Reg tr_Reg);
subroutine, public dyed_channel_update_flow(OBC OBC, CS CS, G G, Time Time);

} // namespace dyed_channel_initialization

Detailed Documentation

Initialization for the dyed_channel configuration.

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

Global Variables

integer ntr = 0

Number of dye tracers.

Global Functions

logical function, public register_dyed_channel_obc(
    param_file param_file,
    CS CS,
    OBC_Reg OBC_Reg
    )

Add dyed channel to OBC registry.

Parameters:

param_file	parameter file.
cs	Dyed channel control structure.
obc_reg	OBC registry.

subroutine, public dyed_channel_obc_end(CS CS)

Clean up the dyed_channel OBC from registry.

Parameters:

cs	Dyed channel control structure.

subroutine, public dyed_channel_set_obc_tracer_data(
    OBC OBC,
    G G,
    GV GV,
    param_file param_file,
    tr_Reg 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	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
param_file	A structure indicating the open file to parse for model parameter values.
tr_reg	Tracer registry.

subroutine, public dyed_channel_update_flow(OBC OBC, CS CS, G G, Time 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	The ocean’s grid structure.
time	model time.