MOM6
mom_boundary_update::update_obc_cs Type Reference

Detailed Description

The control structure for the MOM_boundary_update module.

Definition at line 37 of file MOM_boundary_update.F90.

Collaboration diagram for mom_boundary_update::update_obc_cs:
[legend]

Public variables and constants

logical use_files = .false.
 If true, use external files for the open boundary. More...
 
logical use_kelvin = .false.
 If true, use the Kelvin wave open boundary. More...
 
logical use_tidal_bay = .false.
 If true, use the tidal_bay open boundary. More...
 
logical use_shelfwave = .false.
 If true, use the shelfwave open boundary. More...
 
logical use_dyed_channel = .false.
 If true, use the dyed channel open boundary. More...
 
type(file_obc_cs), pointer file_obc_csp => NULL()
 Pointers to the control structures for named OBC specifications. More...
 
type(kelvin_obc_cs), pointer kelvin_obc_csp => NULL()
 Pointers to the control structures for named OBC specifications. More...
 
type(tidal_bay_obc_cs), pointer tidal_bay_obc_csp => NULL()
 Pointers to the control structures for named OBC specifications. More...
 
type(shelfwave_obc_cs), pointer shelfwave_obc_csp => NULL()
 Pointers to the control structures for named OBC specifications. More...
 
type(dyed_channel_obc_cs), pointer dyed_channel_obc_csp => NULL()
 Pointers to the control structures for named OBC specifications. More...
 

Variables and constants

◆ dyed_channel_obc_csp

type(dyed_channel_obc_cs), pointer mom_boundary_update::update_obc_cs::dyed_channel_obc_csp => NULL()

Pointers to the control structures for named OBC specifications.

Definition at line 48 of file MOM_boundary_update.F90.

48  type(dyed_channel_OBC_CS), pointer :: dyed_channel_OBC_CSp => null()

◆ file_obc_csp

type(file_obc_cs), pointer mom_boundary_update::update_obc_cs::file_obc_csp => NULL()

Pointers to the control structures for named OBC specifications.

Definition at line 44 of file MOM_boundary_update.F90.

44  type(file_OBC_CS), pointer :: file_OBC_CSp => null()

◆ kelvin_obc_csp

type(kelvin_obc_cs), pointer mom_boundary_update::update_obc_cs::kelvin_obc_csp => NULL()

Pointers to the control structures for named OBC specifications.

Definition at line 45 of file MOM_boundary_update.F90.

45  type(Kelvin_OBC_CS), pointer :: Kelvin_OBC_CSp => null()

◆ shelfwave_obc_csp

type(shelfwave_obc_cs), pointer mom_boundary_update::update_obc_cs::shelfwave_obc_csp => NULL()

Pointers to the control structures for named OBC specifications.

Definition at line 47 of file MOM_boundary_update.F90.

47  type(shelfwave_OBC_CS), pointer :: shelfwave_OBC_CSp => null()

◆ tidal_bay_obc_csp

type(tidal_bay_obc_cs), pointer mom_boundary_update::update_obc_cs::tidal_bay_obc_csp => NULL()

Pointers to the control structures for named OBC specifications.

Definition at line 46 of file MOM_boundary_update.F90.

46  type(tidal_bay_OBC_CS), pointer :: tidal_bay_OBC_CSp => null()

◆ use_dyed_channel

logical mom_boundary_update::update_obc_cs::use_dyed_channel = .false.

If true, use the dyed channel open boundary.

Definition at line 42 of file MOM_boundary_update.F90.

42  logical :: use_dyed_channel = .false. !< If true, use the dyed channel open boundary.

◆ use_files

logical mom_boundary_update::update_obc_cs::use_files = .false.

If true, use external files for the open boundary.

Definition at line 38 of file MOM_boundary_update.F90.

38  logical :: use_files = .false. !< If true, use external files for the open boundary.

◆ use_kelvin

logical mom_boundary_update::update_obc_cs::use_kelvin = .false.

If true, use the Kelvin wave open boundary.

Definition at line 39 of file MOM_boundary_update.F90.

39  logical :: use_Kelvin = .false. !< If true, use the Kelvin wave open boundary.

◆ use_shelfwave

logical mom_boundary_update::update_obc_cs::use_shelfwave = .false.

If true, use the shelfwave open boundary.

Definition at line 41 of file MOM_boundary_update.F90.

41  logical :: use_shelfwave = .false. !< If true, use the shelfwave open boundary.

◆ use_tidal_bay

logical mom_boundary_update::update_obc_cs::use_tidal_bay = .false.

If true, use the tidal_bay open boundary.

Definition at line 40 of file MOM_boundary_update.F90.

40  logical :: use_tidal_bay = .false. !< If true, use the tidal_bay open boundary.

The documentation for this type was generated from the following file: