namespace kelvin_initialization

Overview

Configures the model for the Kelvin wave experiment. More…

namespace kelvin_initialization {

// global functions

logical function, public register_kelvin_obc(param_file param_file, CS CS, OBC_Reg OBC_Reg);
subroutine, public kelvin_obc_end(CS CS);
subroutine, public kelvin_initialize_topography(D D, G G, param_file param_file, max_depth max_depth, US US);
subroutine, public kelvin_set_obc_data(OBC OBC, CS CS, G G, GV GV, US US, h h, Time Time);

} // namespace kelvin_initialization

Detailed Documentation

Configures the model for the Kelvin wave experiment.

Kelvin = coastally-trapped Kelvin waves from the ROMS examples. Initialize with level surfaces and drive the wave in at the west, radiate out at the east.

Global Functions

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

Add Kelvin wave to OBC registry.

Parameters:

param_file	parameter file.
cs	Kelvin wave control structure.
obc_reg	OBC registry.

subroutine, public kelvin_obc_end(CS CS)

Clean up the Kelvin wave OBC from registry.

Parameters:

cs	Kelvin wave control structure.

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

This subroutine sets up the Kelvin topography and land mask.

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 kelvin_set_obc_data(
    OBC OBC,
    CS CS,
    G G,
    GV GV,
    US US,
    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	Kelvin wave control structure.
g	The ocean’s grid structure.
gv	The ocean’s vertical grid structure.
us	A dimensional unit scaling type
h	layer thickness [H ~> m or kg m-2].
time	model time.