tidal_bay_initialization module reference¶
Configures the model for the “tidal_bay” experiment. tidal_bay = Tidally resonant bay from Zygmunt Kowalik’s class on tides.
Data Types¶
Control structure for tidal bay open boundaries. |
Functions/Subroutines¶
Add tidal bay to OBC registry. |
|
This subroutine sets the properties of flow at open boundary conditions. |
Detailed Description¶
Configures the model for the “tidal_bay” experiment. tidal_bay = Tidally resonant bay from Zygmunt Kowalik’s class on tides.
Type Documentation¶
-
type
tidal_bay_initialization/tidal_bay_obc_cs¶ Control structure for tidal bay open boundaries.
- Type fields:
%tide_flow[real] :: Maximum tidal flux with the tidal bay configuration [L2 Z T-1 ~> m3 s-1].%tide_period[real] :: The period associated with the tidal bay configuration [T ~> s].%tide_ssh_amp[real] :: The magnitude of the sea surface height anomalies at the inflow with the tidal bay configuration [Z ~> m].
Function/Subroutine Documentation¶
-
function
tidal_bay_initialization/register_tidal_bay_obc(param_file, CS, US, OBC_Reg) [logical]¶ Add tidal bay to OBC registry.
- Parameters:
param_file :: [in] parameter file.
cs :: [inout] tidal bay control structure.
us :: [in] A dimensional unit scaling type
obc_reg :: OBC registry.
-
subroutine
tidal_bay_initialization/tidal_bay_set_obc_data(OBC, CS, G, GV, US, h, 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 :: [in] tidal bay 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 :: [in] layer thickness [H ~> m or kg m-2]
time :: [in] model time.