Detailed Description

The barotropic stepping open boundary condition type.

Definition at line 67 of file MOM_barotropic.F90.

Collaboration diagram for mom_barotropic::bt_obc_type:

Private variables and constants
real, dimension(:,:), pointer	cg_u => NULL()
	The external wave speed at u-points [L T-1 ~> m s-1]. More...

real, dimension(:,:), pointer	cg_v => NULL()
	The external wave speed at u-points [L T-1 ~> m s-1]. More...

real, dimension(:,:), pointer	h_u => NULL()
	The total thickness at the u-points [H ~> m or kg m-2]. More...

real, dimension(:,:), pointer	h_v => NULL()
	The total thickness at the v-points [H ~> m or kg m-2]. More...

real, dimension(:,:), pointer	uhbt => NULL()
	The zonal barotropic thickness fluxes specified for open boundary conditions (if any) [H L2 T-1 ~> m3 s-1 or kg s-1]. More...

real, dimension(:,:), pointer	vhbt => NULL()
	The meridional barotropic thickness fluxes specified for open boundary conditions (if any) [H L2 T-1 ~> m3 s-1 or kg s-1]. More...

real, dimension(:,:), pointer	ubt_outer => NULL()
	The zonal velocities just outside the domain, as set by the open boundary conditions [L T-1 ~> m s-1]. More...

real, dimension(:,:), pointer	vbt_outer => NULL()
	The meridional velocities just outside the domain, as set by the open boundary conditions [L T-1 ~> m s-1]. More...

real, dimension(:,:), pointer	eta_outer_u => NULL()
	The surface height outside of the domain at a u-point with an open boundary condition [H ~> m or kg m-2]. More...

real, dimension(:,:), pointer	eta_outer_v => NULL()
	The surface height outside of the domain at a v-point with an open boundary condition [H ~> m or kg m-2]. More...

logical	apply_u_obcs
	True if this PE has an open boundary at a u-point. More...

logical	apply_v_obcs
	True if this PE has an open boundary at a v-point. More...


integer	is_u_obc
	Index ranges for the open boundary conditions. More...

integer	ie_u_obc
	Index ranges for the open boundary conditions. More...

integer	js_u_obc
	Index ranges for the open boundary conditions. More...

integer	je_u_obc
	Index ranges for the open boundary conditions. More...

integer	is_v_obc
	Index ranges for the open boundary conditions. More...

integer	ie_v_obc
	Index ranges for the open boundary conditions. More...

integer	js_v_obc
	Index ranges for the open boundary conditions. More...

integer	je_v_obc
	Index ranges for the open boundary conditions. More...

logical	is_alloced = .false.
	True if BT_OBC is in use and has been allocated. More...

type(group_pass_type)	pass_uv
	Structure for group halo pass. More...

type(group_pass_type)	pass_uhvh
	Structure for group halo pass. More...

type(group_pass_type)	pass_h
	Structure for group halo pass. More...

type(group_pass_type)	pass_cg
	Structure for group halo pass. More...

type(group_pass_type)	pass_eta_outer
	Structure for group halo pass. More...

Variables and constants

◆ apply_u_obcs

logical mom_barotropic::bt_obc_type::apply_u_obcs

private

True if this PE has an open boundary at a u-point.

Definition at line 84 of file MOM_barotropic.F90.

84 logical :: apply_u_OBCs !< True if this PE has an open boundary at a u-point.

◆ apply_v_obcs

logical mom_barotropic::bt_obc_type::apply_v_obcs

private

True if this PE has an open boundary at a v-point.

Definition at line 85 of file MOM_barotropic.F90.

85 logical :: apply_v_OBCs !< True if this PE has an open boundary at a v-point.

◆ cg_u

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::cg_u => NULL()

private

The external wave speed at u-points [L T-1 ~> m s-1].

Definition at line 68 of file MOM_barotropic.F90.

68 real, dimension(:,:), pointer :: Cg_u => null() !< The external wave speed at u-points [L T-1 ~> m s-1].

◆ cg_v

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::cg_v => NULL()

private

The external wave speed at u-points [L T-1 ~> m s-1].

Definition at line 69 of file MOM_barotropic.F90.

69 real, dimension(:,:), pointer :: Cg_v => null() !< The external wave speed at u-points [L T-1 ~> m s-1].

◆ eta_outer_u

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::eta_outer_u => NULL()

private

The surface height outside of the domain at a u-point with an open boundary condition [H ~> m or kg m-2].

Definition at line 80 of file MOM_barotropic.F90.

80 real, dimension(:,:), pointer :: eta_outer_u => null() !< The surface height outside of the domain

◆ eta_outer_v

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::eta_outer_v => NULL()

private

The surface height outside of the domain at a v-point with an open boundary condition [H ~> m or kg m-2].

Definition at line 82 of file MOM_barotropic.F90.

82 real, dimension(:,:), pointer :: eta_outer_v => null() !< The surface height outside of the domain

◆ h_u

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::h_u => NULL()

private

The total thickness at the u-points [H ~> m or kg m-2].

Definition at line 70 of file MOM_barotropic.F90.

70 real, dimension(:,:), pointer :: H_u => null() !< The total thickness at the u-points [H ~> m or kg m-2].

◆ h_v

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::h_v => NULL()

private

The total thickness at the v-points [H ~> m or kg m-2].

Definition at line 71 of file MOM_barotropic.F90.

71 real, dimension(:,:), pointer :: H_v => null() !< The total thickness at the v-points [H ~> m or kg m-2].

◆ ie_u_obc

integer mom_barotropic::bt_obc_type::ie_u_obc

private

Index ranges for the open boundary conditions.

Definition at line 87 of file MOM_barotropic.F90.

◆ ie_v_obc

integer mom_barotropic::bt_obc_type::ie_v_obc

private

Index ranges for the open boundary conditions.

Definition at line 88 of file MOM_barotropic.F90.

◆ is_alloced

logical mom_barotropic::bt_obc_type::is_alloced = .false.

private

True if BT_OBC is in use and has been allocated.

Definition at line 90 of file MOM_barotropic.F90.

90 logical :: is_alloced = .false. !< True if BT_OBC is in use and has been allocated

◆ is_u_obc

integer mom_barotropic::bt_obc_type::is_u_obc

private

Index ranges for the open boundary conditions.

Definition at line 87 of file MOM_barotropic.F90.

87 integer :: is_u_obc, ie_u_obc, js_u_obc, je_u_obc

◆ is_v_obc

integer mom_barotropic::bt_obc_type::is_v_obc

private

Index ranges for the open boundary conditions.

Definition at line 88 of file MOM_barotropic.F90.

88 integer :: is_v_obc, ie_v_obc, js_v_obc, je_v_obc

◆ je_u_obc

integer mom_barotropic::bt_obc_type::je_u_obc

private

Index ranges for the open boundary conditions.

Definition at line 87 of file MOM_barotropic.F90.

◆ je_v_obc

integer mom_barotropic::bt_obc_type::je_v_obc

private

Index ranges for the open boundary conditions.

Definition at line 88 of file MOM_barotropic.F90.

◆ js_u_obc

integer mom_barotropic::bt_obc_type::js_u_obc

private

Index ranges for the open boundary conditions.

Definition at line 87 of file MOM_barotropic.F90.

◆ js_v_obc

integer mom_barotropic::bt_obc_type::js_v_obc

private

Index ranges for the open boundary conditions.

Definition at line 88 of file MOM_barotropic.F90.

◆ pass_cg

type(group_pass_type) mom_barotropic::bt_obc_type::pass_cg

private

Structure for group halo pass.

Definition at line 95 of file MOM_barotropic.F90.

95 type(group_pass_type) :: pass_cg !< Structure for group halo pass

◆ pass_eta_outer

type(group_pass_type) mom_barotropic::bt_obc_type::pass_eta_outer

private

Structure for group halo pass.

Definition at line 96 of file MOM_barotropic.F90.

96 type(group_pass_type) :: pass_eta_outer !< Structure for group halo pass

◆ pass_h

type(group_pass_type) mom_barotropic::bt_obc_type::pass_h

private

Structure for group halo pass.

Definition at line 94 of file MOM_barotropic.F90.

94 type(group_pass_type) :: pass_h !< Structure for group halo pass

◆ pass_uhvh

type(group_pass_type) mom_barotropic::bt_obc_type::pass_uhvh

private

Structure for group halo pass.

Definition at line 93 of file MOM_barotropic.F90.

93 type(group_pass_type) :: pass_uhvh !< Structure for group halo pass

◆ pass_uv

type(group_pass_type) mom_barotropic::bt_obc_type::pass_uv

private

Structure for group halo pass.

Definition at line 92 of file MOM_barotropic.F90.

92 type(group_pass_type) :: pass_uv !< Structure for group halo pass

◆ ubt_outer

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::ubt_outer => NULL()

private

The zonal velocities just outside the domain, as set by the open boundary conditions [L T-1 ~> m s-1].

Definition at line 76 of file MOM_barotropic.F90.

76 real, dimension(:,:), pointer :: ubt_outer => null() !< The zonal velocities just outside the domain,

◆ uhbt

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::uhbt => NULL()

private

The zonal barotropic thickness fluxes specified for open boundary conditions (if any) [H L2 T-1 ~> m3 s-1 or kg s-1].

Definition at line 72 of file MOM_barotropic.F90.

72 real, dimension(:,:), pointer :: uhbt => null() !< The zonal barotropic thickness fluxes specified

◆ vbt_outer

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::vbt_outer => NULL()

private

The meridional velocities just outside the domain, as set by the open boundary conditions [L T-1 ~> m s-1].

Definition at line 78 of file MOM_barotropic.F90.

78 real, dimension(:,:), pointer :: vbt_outer => null() !< The meridional velocities just outside the domain,

◆ vhbt

real, dimension(:,:), pointer mom_barotropic::bt_obc_type::vhbt => NULL()

private

The meridional barotropic thickness fluxes specified for open boundary conditions (if any) [H L2 T-1 ~> m3 s-1 or kg s-1].

Definition at line 74 of file MOM_barotropic.F90.

74 real, dimension(:,:), pointer :: vhbt => null() !< The meridional barotropic thickness fluxes specified

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

/glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/core/MOM_barotropic.F90

Detailed Description

Private variables and constants

Variables and constants

◆ apply_u_obcs

◆ apply_v_obcs

◆ cg_u

◆ cg_v

◆ eta_outer_u

◆ eta_outer_v

◆ h_u

◆ h_v

◆ ie_u_obc

◆ ie_v_obc

◆ is_alloced

◆ is_u_obc

◆ is_v_obc

◆ je_u_obc

◆ je_v_obc

◆ js_u_obc

◆ js_v_obc

◆ pass_cg

◆ pass_eta_outer

◆ pass_h

◆ pass_uhvh

◆ pass_uv

◆ ubt_outer

◆ uhbt

◆ vbt_outer

◆ vhbt