Detailed Description

Structure that contains pointers to the mechanical forcing at the surface used to drive the liquid ocean simulated by MOM. Data in this type is allocated in the module MOM_surface_forcing.F90, of which there are three versions: solo, coupled, and ice-shelf.

Definition at line 187 of file MOM_forcing_type.F90.

Collaboration diagram for mom_forcing_type::mech_forcing:

[legend]

Public variables and constants
real, dimension(:,:), pointer	taux => NULL()
	zonal wind stress [R L Z T-2 ~> Pa] More...

real, dimension(:,:), pointer	tauy => NULL()
	meridional wind stress [R L Z T-2 ~> Pa] More...

real, dimension(:,:), pointer	ustar => NULL()
	surface friction velocity scale [Z T-1 ~> m s-1]. More...

real, dimension(:,:), pointer	net_mass_src => NULL()
	The net mass source to the ocean [kg m-2 s-1]. More...

real, dimension(:,:), pointer	p_surf_full => NULL()
	Pressure at the top ocean interface [Pa]. if there is sea-ice, then p_surf_flux is at ice-ocean interface. More...

real, dimension(:,:), pointer	p_surf => NULL()
	Pressure at the top ocean interface [Pa] as used to drive the ocean model. If p_surf is limited, p_surf may be smaller than p_surf_full, otherwise they are the same. More...

real, dimension(:,:), pointer	p_surf_ssh => NULL()
	Pressure at the top ocean interface that is used in corrections to the sea surface height field that is passed back to the calling routines. p_surf_SSH may point to p_surf or to p_surf_full. More...

real, dimension(:,:), pointer	area_berg => NULL()
	fractional area of ocean surface covered by icebergs [m2 m-2] More...

real, dimension(:,:), pointer	mass_berg => NULL()
	mass of icebergs per unit ocean area [kg m-2] More...

real, dimension(:,:), pointer	frac_shelf_u => NULL()
	Fractional ice shelf coverage of u-cells, nondimensional from 0 to 1 [nondim]. This is only associated if ice shelves are enabled, and is exactly 0 away from shelves or on land. More...

real, dimension(:,:), pointer	frac_shelf_v => NULL()
	Fractional ice shelf coverage of v-cells, nondimensional from 0 to 1 [nondim]. This is only associated if ice shelves are enabled, and is exactly 0 away from shelves or on land. More...

real, dimension(:,:), pointer	rigidity_ice_u => NULL()
	Depth-integrated lateral viscosity of ice shelves or sea ice at u-points [m3 s-1]. More...

real, dimension(:,:), pointer	rigidity_ice_v => NULL()
	Depth-integrated lateral viscosity of ice shelves or sea ice at v-points [m3 s-1]. More...

real	dt_force_accum = -1.0
	The amount of time over which the mechanical forcing fluxes have been averaged [s]. More...

logical	net_mass_src_set = .false.
	If true, an estimate of net_mass_src has been provided. More...

logical	accumulate_p_surf = .false.
	If true, the surface pressure due to the atmosphere and various types of ice needs to be accumulated, and the surface pressure explicitly reset to zero at the driver level when appropriate. More...

logical	accumulate_rigidity = .false.
	If true, the rigidity due to various types of ice needs to be accumulated, and the rigidity explicitly reset to zero at the driver level when appropriate. More...

logical	initialized = .false.
	This indicates whether the appropriate arrays have been initialized. More...

Variables and constants

◆ accumulate_p_surf

logical mom_forcing_type::mech_forcing::accumulate_p_surf = .false.

If true, the surface pressure due to the atmosphere and various types of ice needs to be accumulated, and the surface pressure explicitly reset to zero at the driver level when appropriate.

Definition at line 225 of file MOM_forcing_type.F90.

225 logical :: accumulate_p_surf = .false. !< If true, the surface pressure due to the atmosphere

◆ accumulate_rigidity

logical mom_forcing_type::mech_forcing::accumulate_rigidity = .false.

If true, the rigidity due to various types of ice needs to be accumulated, and the rigidity explicitly reset to zero at the driver level when appropriate.

Definition at line 229 of file MOM_forcing_type.F90.

229 logical :: accumulate_rigidity = .false. !< If true, the rigidity due to various types of

◆ area_berg

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::area_berg => NULL()

fractional area of ocean surface covered by icebergs [m2 m-2]

Definition at line 208 of file MOM_forcing_type.F90.

   real, pointer, dimension(:,:) :: &
     area_berg  => null(), &    !< fractional area of ocean surface covered by icebergs [m2 m-2]
     mass_berg  => null()       !< mass of icebergs per unit ocean area [kg m-2]

◆ dt_force_accum

real mom_forcing_type::mech_forcing::dt_force_accum = -1.0

The amount of time over which the mechanical forcing fluxes have been averaged [s].

Definition at line 222 of file MOM_forcing_type.F90.

222 real :: dt_force_accum = -1.0 !< The amount of time over which the mechanical forcing fluxes

◆ frac_shelf_u

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::frac_shelf_u => NULL()

Fractional ice shelf coverage of u-cells, nondimensional from 0 to 1 [nondim]. This is only associated if ice shelves are enabled, and is exactly 0 away from shelves or on land.

Definition at line 213 of file MOM_forcing_type.F90.

213 real, pointer, dimension(:,:) :: frac_shelf_u => null() !< Fractional ice shelf coverage of u-cells,

◆ frac_shelf_v

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::frac_shelf_v => NULL()

Fractional ice shelf coverage of v-cells, nondimensional from 0 to 1 [nondim]. This is only associated if ice shelves are enabled, and is exactly 0 away from shelves or on land.

Definition at line 216 of file MOM_forcing_type.F90.

216 real, pointer, dimension(:,:) :: frac_shelf_v => null() !< Fractional ice shelf coverage of v-cells,

◆ initialized

logical mom_forcing_type::mech_forcing::initialized = .false.

This indicates whether the appropriate arrays have been initialized.

Definition at line 233 of file MOM_forcing_type.F90.

233 logical :: initialized = .false. !< This indicates whether the appropriate arrays have been initialized.

◆ mass_berg

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::mass_berg => NULL()

mass of icebergs per unit ocean area [kg m-2]

Definition at line 208 of file MOM_forcing_type.F90.

◆ net_mass_src

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::net_mass_src => NULL()

The net mass source to the ocean [kg m-2 s-1].

Definition at line 189 of file MOM_forcing_type.F90.

◆ net_mass_src_set

logical mom_forcing_type::mech_forcing::net_mass_src_set = .false.

If true, an estimate of net_mass_src has been provided.

Definition at line 224 of file MOM_forcing_type.F90.

224 logical :: net_mass_src_set = .false. !< If true, an estimate of net_mass_src has been provided.

◆ p_surf

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::p_surf => NULL()

Pressure at the top ocean interface [Pa] as used to drive the ocean model. If p_surf is limited, p_surf may be smaller than p_surf_full, otherwise they are the same.

Definition at line 199 of file MOM_forcing_type.F90.

199 real, pointer, dimension(:,:) :: p_surf => null()

◆ p_surf_full

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::p_surf_full => NULL()

Pressure at the top ocean interface [Pa]. if there is sea-ice, then p_surf_flux is at ice-ocean interface.

Definition at line 196 of file MOM_forcing_type.F90.

196 real, pointer, dimension(:,:) :: p_surf_full => null()

◆ p_surf_ssh

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::p_surf_ssh => NULL()

Pressure at the top ocean interface that is used in corrections to the sea surface height field that is passed back to the calling routines. p_surf_SSH may point to p_surf or to p_surf_full.

Definition at line 202 of file MOM_forcing_type.F90.

202 real, pointer, dimension(:,:) :: p_surf_SSH => null()

◆ rigidity_ice_u

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::rigidity_ice_u => NULL()

Depth-integrated lateral viscosity of ice shelves or sea ice at u-points [m3 s-1].

Definition at line 219 of file MOM_forcing_type.F90.

   real, pointer, dimension(:,:) :: &
     rigidity_ice_u => null(), & !< Depth-integrated lateral viscosity of ice shelves or sea ice at u-points [m3 s-1]
     rigidity_ice_v => null()    !< Depth-integrated lateral viscosity of ice shelves or sea ice at v-points [m3 s-1]

◆ rigidity_ice_v

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::rigidity_ice_v => NULL()

Depth-integrated lateral viscosity of ice shelves or sea ice at v-points [m3 s-1].

Definition at line 219 of file MOM_forcing_type.F90.

◆ taux

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::taux => NULL()

zonal wind stress [R L Z T-2 ~> Pa]

Definition at line 189 of file MOM_forcing_type.F90.

   real, pointer, dimension(:,:) :: &
     taux  => null(), & !< zonal wind stress [R L Z T-2 ~> Pa]
     tauy  => null(), & !< meridional wind stress [R L Z T-2 ~> Pa]
     ustar => null(), & !< surface friction velocity scale [Z T-1 ~> m s-1].
     net_mass_src => null() !< The net mass source to the ocean [kg m-2 s-1].

◆ tauy

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::tauy => NULL()

meridional wind stress [R L Z T-2 ~> Pa]

Definition at line 189 of file MOM_forcing_type.F90.

◆ ustar

real, dimension(:,:), pointer mom_forcing_type::mech_forcing::ustar => NULL()

surface friction velocity scale [Z T-1 ~> m s-1].

Definition at line 189 of file MOM_forcing_type.F90.

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_forcing_type.F90

Detailed Description

Public variables and constants

Variables and constants

◆ accumulate_p_surf

◆ accumulate_rigidity

◆ area_berg

◆ dt_force_accum

◆ frac_shelf_u

◆ frac_shelf_v

◆ initialized

◆ mass_berg

◆ net_mass_src

◆ net_mass_src_set

◆ p_surf

◆ p_surf_full

◆ p_surf_ssh

◆ rigidity_ice_u

◆ rigidity_ice_v

◆ taux

◆ tauy

◆ ustar