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.

More…

Data Types

tidal_bay_obc_cs

Control structure for tidal bay open boundaries.

Functions/Subroutines

register_tidal_bay_obc()

Add tidal bay to OBC registry.

tidal_bay_obc_end()

Clean up the tidal bay OBC from registry.

tidal_bay_set_obc_data()

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 [L2 Z T-1 ~> m3 s-1].

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 :: tidal bay control structure.

  • us :: [in] A dimensional unit scaling type

  • obc_reg :: OBC registry.

Call to

mom_error_handler::mom_error

subroutine tidal_bay_initialization/tidal_bay_obc_end(CS)

Clean up the tidal bay OBC from registry.

Parameters

cs :: tidal bay control structure.

Called from

mom_boundary_update::obc_register_end

subroutine tidal_bay_initialization/tidal_bay_set_obc_data(OBC, CS, G, GV, 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 :: tidal bay control structure.

  • g :: [in] The ocean’s grid structure.

  • gv :: [in] The ocean’s vertical grid structure

  • h :: [in] layer thickness [H ~> m or kg m-2]

  • time :: [in] model time.