namespace tidal_bay_initialization

Overview

Configures the model for the “tidal_bay” experiment. tidal_bay = Tidally resonant bay from Zygmunt Kowalik’s class on tides. More…

namespace tidal_bay_initialization {

// global functions

logical function, public register_tidal_bay_obc(param_file param_file, CS CS, OBC_Reg OBC_Reg);
subroutine, public tidal_bay_obc_end(CS CS);
subroutine, public tidal_bay_set_obc_data(OBC OBC, CS CS, G G, h h, Time Time);

} // namespace tidal_bay_initialization

Detailed Documentation

Configures the model for the “tidal_bay” experiment. tidal_bay = Tidally resonant bay from Zygmunt Kowalik’s class on tides.

Global Functions

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

Add tidal bay to OBC registry.

Parameters:

param_file	parameter file.
cs	tidal bay control structure.
obc_reg	OBC registry.

subroutine, public tidal_bay_obc_end(CS CS)

Clean up the tidal bay OBC from registry.

Parameters:

cs	tidal bay control structure.

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