namespace shelfwave_initialization

Overview

Configures the model for the idealized shelfwave test case. More…

namespace shelfwave_initialization {

// global functions

logical function, public register_shelfwave_obc(param_file param_file, CS CS, OBC_Reg OBC_Reg);
subroutine, public shelfwave_obc_end(CS CS);
subroutine, public shelfwave_initialize_topography(D D, G G, param_file param_file, max_depth max_depth, US US);
subroutine, public shelfwave_set_obc_data(OBC OBC, CS CS, G G, h h, Time Time);

} // namespace shelfwave_initialization

Detailed Documentation

Configures the model for the idealized shelfwave test case.

Global Functions

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

Add shelfwave to OBC registry.

Parameters:

param_file	parameter file.
cs	shelfwave control structure.
obc_reg	OBC registry.

subroutine, public shelfwave_obc_end(CS CS)

Clean up the shelfwave OBC from registry.

Parameters:

cs	shelfwave control structure.

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

Initialization of topography.

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 shelfwave_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.