MOM6
mom_diabatic_aux::diabatic_aux_cs Type Reference

Detailed Description

Control structure for diabatic_aux.

Definition at line 42 of file MOM_diabatic_aux.F90.

Collaboration diagram for mom_diabatic_aux::diabatic_aux_cs:
[legend]

Public variables and constants

logical do_rivermix = .false.
 Provide additional TKE to mix river runoff at the river mouths to a depth of "rivermix_depth". More...
 
real rivermix_depth = 0.0
 The depth to which rivers are mixed if do_rivermix = T [Z ~> m]. More...
 
logical reclaim_frazil
 If true, try to use any frazil heat deficit to to cool the topmost layer down to the freezing point. The default is false. More...
 
logical pressure_dependent_frazil
 If true, use a pressure dependent freezing temperature when making frazil. The default is false, which will be faster but is inappropriate with ice-shelf cavities. More...
 
logical ignore_fluxes_over_land
 If true, the model does not check if fluxes are applied over land points. This flag must be used when the ocean is coupled with sea ice and ice shelves and use_ePBL = true. More...
 
logical use_river_heat_content
 If true, assumes that ice-ocean boundary has provided a river heat content. Otherwise, runoff is added with a temperature of the local SST. More...
 
logical use_calving_heat_content
 If true, assumes that ice-ocean boundary has provided a calving heat content. Otherwise, calving is added with a temperature of the local SST. More...
 
logical var_pen_sw
 If true, use one of the CHL_A schemes to determine the e-folding depth of incoming shortwave radiation. More...
 
integer sbc_chl
 An integer handle used in time interpolation of chlorophyll read from a file. More...
 
logical chl_from_file
 If true, chl_a is read from a file. More...
 
type(time_type), pointer time => NULL()
 A pointer to the ocean model's clock. More...
 
type(diag_ctrl), pointer diag
 Structure used to regulate timing of diagnostic output. More...
 
integer id_createdh = -1
 Diagnostic ID of mass added to avoid grounding. More...
 
integer id_brine_lay = -1
 Diagnostic ID of which layer receives the brine. More...
 
integer id_pensw_diag = -1
 Diagnostic ID of Penetrative shortwave heating (flux convergence) More...
 
integer id_penswflux_diag = -1
 Diagnostic ID of Penetrative shortwave flux. More...
 
integer id_nonpensw_diag = -1
 Diagnostic ID of Non-penetrative shortwave heating. More...
 
integer id_chl = -1
 Diagnostic ID of chlorophyll-A handles for opacity. More...
 
real, dimension(:,:), allocatable createdh
 The amount of volume added in order to avoid grounding [H T-1 ~> m s-1]. More...
 
real, dimension(:,:,:), allocatable pensw_diag
 Heating in a layer from convergence of penetrative SW [W m-2]. More...
 
real, dimension(:,:,:), allocatable penswflux_diag
 Penetrative SW flux at base of grid layer [W m-2]. More...
 
real, dimension(:,:), allocatable nonpensw_diag
 Non-downwelling SW radiation at ocean surface [W m-2]. More...
 

Variables and constants

◆ chl_from_file

logical mom_diabatic_aux::diabatic_aux_cs::chl_from_file

If true, chl_a is read from a file.

Definition at line 67 of file MOM_diabatic_aux.F90.

67  logical :: chl_from_file !< If true, chl_a is read from a file.

◆ createdh

real, dimension(:,:), allocatable mom_diabatic_aux::diabatic_aux_cs::createdh

The amount of volume added in order to avoid grounding [H T-1 ~> m s-1].

Definition at line 81 of file MOM_diabatic_aux.F90.

81  real, allocatable, dimension(:,:) :: createdH !< The amount of volume added in order to

◆ diag

type(diag_ctrl), pointer mom_diabatic_aux::diabatic_aux_cs::diag

Structure used to regulate timing of diagnostic output.

Definition at line 70 of file MOM_diabatic_aux.F90.

70  type(diag_ctrl), pointer :: diag !< Structure used to regulate timing of diagnostic output

◆ do_rivermix

logical mom_diabatic_aux::diabatic_aux_cs::do_rivermix = .false.

Provide additional TKE to mix river runoff at the river mouths to a depth of "rivermix_depth".

Definition at line 43 of file MOM_diabatic_aux.F90.

43  logical :: do_rivermix = .false. !< Provide additional TKE to mix river runoff at the

◆ id_brine_lay

integer mom_diabatic_aux::diabatic_aux_cs::id_brine_lay = -1

Diagnostic ID of which layer receives the brine.

Definition at line 74 of file MOM_diabatic_aux.F90.

74  integer :: id_brine_lay = -1 !< Diagnostic ID of which layer receives the brine

◆ id_chl

integer mom_diabatic_aux::diabatic_aux_cs::id_chl = -1

Diagnostic ID of chlorophyll-A handles for opacity.

Definition at line 78 of file MOM_diabatic_aux.F90.

78  integer :: id_Chl = -1 !< Diagnostic ID of chlorophyll-A handles for opacity

◆ id_createdh

integer mom_diabatic_aux::diabatic_aux_cs::id_createdh = -1

Diagnostic ID of mass added to avoid grounding.

Definition at line 73 of file MOM_diabatic_aux.F90.

73  integer :: id_createdH = -1 !< Diagnostic ID of mass added to avoid grounding

◆ id_nonpensw_diag

integer mom_diabatic_aux::diabatic_aux_cs::id_nonpensw_diag = -1

Diagnostic ID of Non-penetrative shortwave heating.

Definition at line 77 of file MOM_diabatic_aux.F90.

77  integer :: id_nonpenSW_diag = -1 !< Diagnostic ID of Non-penetrative shortwave heating

◆ id_pensw_diag

integer mom_diabatic_aux::diabatic_aux_cs::id_pensw_diag = -1

Diagnostic ID of Penetrative shortwave heating (flux convergence)

Definition at line 75 of file MOM_diabatic_aux.F90.

75  integer :: id_penSW_diag = -1 !< Diagnostic ID of Penetrative shortwave heating (flux convergence)

◆ id_penswflux_diag

integer mom_diabatic_aux::diabatic_aux_cs::id_penswflux_diag = -1

Diagnostic ID of Penetrative shortwave flux.

Definition at line 76 of file MOM_diabatic_aux.F90.

76  integer :: id_penSWflux_diag = -1 !< Diagnostic ID of Penetrative shortwave flux

◆ ignore_fluxes_over_land

logical mom_diabatic_aux::diabatic_aux_cs::ignore_fluxes_over_land

If true, the model does not check if fluxes are applied over land points. This flag must be used when the ocean is coupled with sea ice and ice shelves and use_ePBL = true.

Definition at line 53 of file MOM_diabatic_aux.F90.

53  logical :: ignore_fluxes_over_land !< If true, the model does not check

◆ nonpensw_diag

real, dimension(:,:), allocatable mom_diabatic_aux::diabatic_aux_cs::nonpensw_diag

Non-downwelling SW radiation at ocean surface [W m-2].

Definition at line 87 of file MOM_diabatic_aux.F90.

87  real, allocatable, dimension(:,:) :: nonpenSW_diag !< Non-downwelling SW radiation at ocean

◆ pensw_diag

real, dimension(:,:,:), allocatable mom_diabatic_aux::diabatic_aux_cs::pensw_diag

Heating in a layer from convergence of penetrative SW [W m-2].

Definition at line 83 of file MOM_diabatic_aux.F90.

83  real, allocatable, dimension(:,:,:) :: penSW_diag !< Heating in a layer from convergence of

◆ penswflux_diag

real, dimension(:,:,:), allocatable mom_diabatic_aux::diabatic_aux_cs::penswflux_diag

Penetrative SW flux at base of grid layer [W m-2].

Definition at line 85 of file MOM_diabatic_aux.F90.

85  real, allocatable, dimension(:,:,:) :: penSWflux_diag !< Penetrative SW flux at base of grid

◆ pressure_dependent_frazil

logical mom_diabatic_aux::diabatic_aux_cs::pressure_dependent_frazil

If true, use a pressure dependent freezing temperature when making frazil. The default is false, which will be faster but is inappropriate with ice-shelf cavities.

Definition at line 49 of file MOM_diabatic_aux.F90.

49  logical :: pressure_dependent_frazil !< If true, use a pressure dependent

◆ reclaim_frazil

logical mom_diabatic_aux::diabatic_aux_cs::reclaim_frazil

If true, try to use any frazil heat deficit to to cool the topmost layer down to the freezing point. The default is false.

Definition at line 46 of file MOM_diabatic_aux.F90.

46  logical :: reclaim_frazil !< If true, try to use any frazil heat deficit to

◆ rivermix_depth

real mom_diabatic_aux::diabatic_aux_cs::rivermix_depth = 0.0

The depth to which rivers are mixed if do_rivermix = T [Z ~> m].

Definition at line 45 of file MOM_diabatic_aux.F90.

45  real :: rivermix_depth = 0.0 !< The depth to which rivers are mixed if do_rivermix = T [Z ~> m].

◆ sbc_chl

integer mom_diabatic_aux::diabatic_aux_cs::sbc_chl

An integer handle used in time interpolation of chlorophyll read from a file.

Definition at line 65 of file MOM_diabatic_aux.F90.

65  integer :: sbc_chl !< An integer handle used in time interpolation of

◆ time

type(time_type), pointer mom_diabatic_aux::diabatic_aux_cs::time => NULL()

A pointer to the ocean model's clock.

Definition at line 69 of file MOM_diabatic_aux.F90.

69  type(time_type), pointer :: Time => null() !< A pointer to the ocean model's clock.

◆ use_calving_heat_content

logical mom_diabatic_aux::diabatic_aux_cs::use_calving_heat_content

If true, assumes that ice-ocean boundary has provided a calving heat content. Otherwise, calving is added with a temperature of the local SST.

Definition at line 60 of file MOM_diabatic_aux.F90.

60  logical :: use_calving_heat_content !< If true, assumes that ice-ocean boundary

◆ use_river_heat_content

logical mom_diabatic_aux::diabatic_aux_cs::use_river_heat_content

If true, assumes that ice-ocean boundary has provided a river heat content. Otherwise, runoff is added with a temperature of the local SST.

Definition at line 57 of file MOM_diabatic_aux.F90.

57  logical :: use_river_heat_content !< If true, assumes that ice-ocean boundary

◆ var_pen_sw

logical mom_diabatic_aux::diabatic_aux_cs::var_pen_sw

If true, use one of the CHL_A schemes to determine the e-folding depth of incoming shortwave radiation.

Definition at line 63 of file MOM_diabatic_aux.F90.

63  logical :: var_pen_sw !< If true, use one of the CHL_A schemes to determine the

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