MOM6
mom_open_boundary::ocean_obc_type Type Reference

Detailed Description

Open-boundary data.

Definition at line 186 of file MOM_open_boundary.F90.

Collaboration diagram for mom_open_boundary::ocean_obc_type:
[legend]

Public variables and constants

integer number_of_segments = 0
 The number of open-boundary segments.
 
integer ke = 0
 The number of model layers.
 
logical open_u_bcs_exist_globally = .false.
 True if any zonal velocity points in the global domain use open BCs.
 
logical open_v_bcs_exist_globally = .false.
 True if any meridional velocity points in the global domain use open BCs.
 
logical flather_u_bcs_exist_globally = .false.
 True if any zonal velocity points in the global domain use Flather BCs.
 
logical flather_v_bcs_exist_globally = .false.
 True if any meridional velocity points in the global domain use Flather BCs.
 
logical oblique_bcs_exist_globally = .false.
 True if any velocity points in the global domain use oblique BCs.
 
logical nudged_u_bcs_exist_globally = .false.
 True if any velocity points in the global domain use nudged BCs.
 
logical nudged_v_bcs_exist_globally = .false.
 True if any velocity points in the global domain use nudged BCs.
 
logical specified_u_bcs_exist_globally = .false.
 True if any zonal velocity points in the global domain use specified BCs.
 
logical specified_v_bcs_exist_globally = .false.
 True if any meridional velocity points in the global domain use specified BCs.
 
logical radiation_bcs_exist_globally = .false.
 True if radiations BCs are in use anywhere.
 
logical user_bcs_set_globally = .false.
 True if any OBC_USER_CONFIG is set for input from user directory.
 
logical update_obc = .false.
 Is OBC data time-dependent.
 
logical needs_io_for_data = .false.
 Is any i/o needed for OBCs.
 
logical zero_vorticity = .false.
 If True, sets relative vorticity to zero on open boundaries.
 
logical freeslip_vorticity = .false.
 If True, sets normal gradient of tangential velocity to zero in the relative vorticity on open boundaries.
 
logical computed_vorticity = .false.
 If True, uses external data for tangential velocity in the relative vorticity on open boundaries.
 
logical specified_vorticity = .false.
 If True, uses external data for tangential velocity gradients in the relative vorticity on open boundaries.
 
logical zero_strain = .false.
 If True, sets strain to zero on open boundaries.
 
logical freeslip_strain = .false.
 If True, sets normal gradient of tangential velocity to zero in the strain on open boundaries.
 
logical computed_strain = .false.
 If True, uses external data for tangential velocity to compute normal gradient in the strain on open boundaries.
 
logical specified_strain = .false.
 If True, uses external data for tangential velocity gradients to compute strain on open boundaries.
 
logical zero_biharmonic = .false.
 If True, zeros the Laplacian of flow on open boundaries for use in the biharmonic viscosity term.
 
logical brushcutter_mode = .false.
 If True, read data on supergrid.
 
real g_earth
 The gravitational acceleration [m s-2].
 
type(obc_segment_type), dimension(:), pointer segment => NULL()
 List of segment objects.
 
integer, dimension(:,:), pointer segnum_u => NULL()
 Segment number of u-points.
 
integer, dimension(:,:), pointer segnum_v => NULL()
 Segment number of v-points.
 
real gamma_uv
 The relative weighting for the baroclinic radiation velocities (or speed of characteristics) at the new time level (1) or the running mean (0) for velocities. Valid values range from 0 to 1, with a default of 0.3.
 
real rx_max
 The maximum magnitude of the baroclinic radiation velocity (or speed of characteristics) [m s-1]. The default value is 10 m s-1.
 
logical obc_pe
 Is there an open boundary on this tile?
 
type(remapping_cs), pointer remap_cs
 ALE remapping control structure for segments only.
 
type(obc_registry_type), pointer obc_reg => NULL()
 Registry type for boundaries.
 
real, dimension(:,:,:), pointer rx_normal => NULL()
 Array storage for restarts.
 
real, dimension(:,:,:), pointer ry_normal => NULL()
 Array storage for restarts.
 
real, dimension(:,:,:), pointer cff_normal => NULL()
 Array storage for restarts.
 
real silly_h
 A silly value of thickness outside of the domain that can be used to test the independence of the OBCs to this external data [H ~> m or kg m-2].
 
real silly_u
 A silly value of velocity outside of the domain that can be used to test the independence of the OBCs to this external data [m s-1].
 

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