Detailed Description

Routines used to calculate the opacity of the ocean.

opacity_from_chl: In this routine, the Morel (modified) or Manizza (modified) schemes use the "blue" band in the paramterizations to determine the e-folding depth of the incoming shortwave attenuation. The red portion is lumped into the net heating at the surface.

Morel, A., 1988: Optical modeling of the upper ocean in relation to its biogenous matter content (case-i waters)., J. Geo. Res., 93, 10,749-10,768.

Manizza, M., C. LeQuere, A. J. Watson, and E. T. Buitenhuis, 2005: Bio-optical feedbacks among phytoplankton, upper ocean physics and sea-ice in a global model, Geophys. Res. Let., 32, L05603, doi:10.1029/2004GL020778.

Data Types
type	opacity_cs
	The control structure with paramters for the MOM_opacity module. More...

type	optics_type
	This type is used to store information about ocean optical properties. More...

integer, parameter	no_scheme = 0
	Coded integers to specify the opacity scheme. More...

integer, parameter	manizza_05 = 1
	Coded integers to specify the opacity scheme. More...

integer, parameter	morel_88 = 2
	Coded integers to specify the opacity scheme. More...

integer, parameter	single_exp = 3
	Coded integers to specify the opacity scheme. More...

integer, parameter	double_exp = 4
	Coded integers to specify the opacity scheme. More...

character *(10), parameter	manizza_05_string = "MANIZZA_05"
	String to specify the opacity scheme. More...

character *(10), parameter	morel_88_string = "MOREL_88"
	String to specify the opacity scheme. More...

character *(10), parameter	single_exp_string = "SINGLE_EXP"
	String to specify the opacity scheme. More...

character *(10), parameter	double_exp_string = "DOUBLE_EXP"
	String to specify the opacity scheme. More...

real, parameter	op_diag_len = 1e-10
	Lengthscale L used to remap opacity from op to 1/L * tanh(op * L) More...

subroutine, public	set_opacity (optics, sw_total, sw_vis_dir, sw_vis_dif, sw_nir_dir, sw_nir_dif, G, GV, CS, chl_2d, chl_3d)
	This sets the opacity of sea water based based on one of several different schemes. More...

subroutine	opacity_from_chl (optics, sw_total, sw_vis_dir, sw_vis_dif, sw_nir_dir, sw_nir_dif, G, GV, CS, chl_2d, chl_3d)
	This sets the "blue" band opacity based on chloophyll A concencentrations The red portion is lumped into the net heating at the surface. More...

real function, public	opacity_morel (chl_data)
	This sets the blue-wavelength opacity according to the scheme proposed by Morel and Antoine (1994). More...

real function	sw_pen_frac_morel (chl_data)
	This sets the penetrating shortwave fraction according to the scheme proposed by Morel and Antoine (1994). More...

real function, public	opacity_manizza (chl_data)
	This sets the blue-wavelength opacity according to the scheme proposed by Manizza, M. et al, 2005. More...

subroutine, public	extract_optics_slice (optics, j, G, GV, opacity, opacity_scale, penSW_top, penSW_scale)
	This subroutine returns a 2-d slice at constant j of fields from an optics_type, with the potential for rescaling these fields. More...

subroutine, public	extract_optics_fields (optics, nbands)
	Set arguments to fields from the optics type. More...

integer function, public	optics_nbands (optics)
	Return the number of bands of penetrating shortwave radiation. More...

subroutine, public	absorbremainingsw (G, GV, US, h, opacity_band, nsw, optics, j, dt, H_limit_fluxes, adjustAbsorptionProfile, absorbAllSW, T, Pen_SW_bnd, eps, ksort, htot, Ttot, TKE, dSV_dT)
	Apply shortwave heating below the boundary layer (when running with the bulk mixed layer inhereted from GOLD) or throughout the water column. More...

subroutine, public	sumswoverbands (G, GV, US, h, nsw, optics, j, dt, H_limit_fluxes, absorbAllSW, iPen_SW_bnd, netPen)
	This subroutine calculates the total shortwave heat flux integrated over bands as a function of depth. This routine is only called for computing buoyancy fluxes for use in KPP. This routine does not updat e the state. More...

subroutine, public	opacity_init (Time, G, GV, US, param_file, diag, CS, optics)
	This routine initalizes the opacity module, including an optics_type. More...

subroutine, public	opacity_end (CS, optics)

Function/Subroutine Documentation

◆ absorbremainingsw()

subroutine, public mom_opacity::absorbremainingsw	(	type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(unit_scale_type), intent(in)	US,
		real, dimension( g %isd: g %ied, gv %ke), intent(in)	h,
		real, dimension(max(1,nsw), g %isd: g %ied, gv %ke), intent(in)	opacity_band,
		integer, intent(in)	nsw,
		type(optics_type), intent(in)	optics,
		integer, intent(in)	j,
		real, intent(in)	dt,
		real, intent(in)	H_limit_fluxes,
		logical, intent(in)	adjustAbsorptionProfile,
		logical, intent(in)	absorbAllSW,
		real, dimension( g %isd: g %ied, gv %ke), intent(inout)	T,
		real, dimension(max(1,nsw), g %isd: g %ied), intent(inout)	Pen_SW_bnd,
		real, dimension( g %isd: g %ied, gv %ke), intent(in), optional	eps,
		integer, dimension( g %isd: g %ied, gv %ke), intent(in), optional	ksort,
		real, dimension( g %isd: g %ied), intent(in), optional	htot,
		real, dimension( g %isd: g %ied), intent(inout), optional	Ttot,
		real, dimension( g %isd: g %ied, gv %ke), intent(inout), optional	TKE,
		real, dimension( g %isd: g %ied, gv %ke), intent(in), optional	dSV_dT
	)

Apply shortwave heating below the boundary layer (when running with the bulk mixed layer inhereted from GOLD) or throughout the water column.

In addition, it causes all of the remaining SW radiation to be absorbed, provided that the total water column thickness is greater than H_limit_fluxes. For thinner water columns, the heating is scaled down proportionately, the assumption being that the remaining heating (which is left in Pen_SW) should go into an (absent for now) ocean bottom sediment layer.

Parameters

[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[in]	us	A dimensional unit scaling type
[in]	nsw	Number of bands of penetrating shortwave radiation.
[in]	h	Layer thicknesses [H ~> m or kg m-2].
[in]	opacity_band	Opacity in each band of penetrating shortwave radiation [H-1 ~> m-1 or m2 kg-1]. The indicies are band, i, k.
[in]	optics	An optics structure that has values of opacities and shortwave fluxes.
[in]	j	j-index to work on.
[in]	dt	Time step [T ~> s].
[in]	h_limit_fluxes	If the total ocean depth is less than this, they are scaled away to avoid numerical instabilities [H ~> m or kg m-2]. This would not be necessary if a finite heat capacity mud-layer were added.
[in]	adjustabsorptionprofile	If true, apply heating above the layers in which it should have occurred to get the correct mean depth (and potential energy change) of the shortwave that should be absorbed by each layer.
[in]	absorballsw	If true, apply heating above the layers in which it should have occurred to get the correct mean depth (and potential energy change) of the shortwave that should be absorbed by each layer.
[in,out]	t	Layer potential/conservative temperatures [degC]
[in,out]	pen_sw_bnd	Penetrating shortwave heating in each band that hits the bottom and will will be redistributed through the water column [degC H ~> degC m or degC kg m-2], size nsw x G isd: G ied.
[in]	eps	Small thickness that must remain in each layer, and which will not be subject to heating [H ~> m or kg m-2]
[in]	ksort	Density-sorted k-indicies.
[in]	htot	Total mixed layer thickness [H ~> m or kg m-2].
[in,out]	ttot	Depth integrated mixed layer temperature [degC H ~> degC m or degC kg m-2]
[in]	dsv_dt	The partial derivative of specific volume with temperature [R-1 degC-1].
[in,out]	tke	The TKE sink from mixing the heating throughout a layer [R Z3 T-2 ~> J m-2].

Definition at line 512 of file MOM_opacity.F90.

  
   type(ocean_grid_type),             intent(in)    :: G    !< The ocean's grid structure.
   type(verticalGrid_type),           intent(in)    :: GV   !< The ocean's vertical grid structure.
   type(unit_scale_type),             intent(in)    :: US   !< A dimensional unit scaling type
   integer,                           intent(in)    :: nsw  !< Number of bands of penetrating
                                                            !! shortwave radiation.
   real, dimension(SZI_(G),SZK_(GV)), intent(in)    :: h    !< Layer thicknesses [H ~> m or kg m-2].
   real, dimension(max(1,nsw),SZI_(G),SZK_(GV)), intent(in) :: opacity_band !< Opacity in each band of penetrating
                                                            !! shortwave radiation [H-1 ~> m-1 or m2 kg-1].
                                                            !! The indicies are band, i, k.
   type(optics_type),                 intent(in)    :: optics !< An optics structure that has values of
                                                            !! opacities and shortwave fluxes.
   integer,                           intent(in)    :: j    !< j-index to work on.
   real,                              intent(in)    :: dt   !< Time step [T ~> s].
   real,                              intent(in)    :: H_limit_fluxes !< If the total ocean depth is
                                                            !! less than this, they are scaled away
                                                            !! to avoid numerical instabilities
                                                            !! [H ~> m or kg m-2]. This would
                                                            !! not be necessary if a finite heat
                                                            !! capacity mud-layer were added.
   logical,                          intent(in)    :: adjustAbsorptionProfile !< If true, apply
                                                            !! heating above the layers in which it
                                                            !! should have occurred to get the
                                                            !! correct mean depth (and potential
                                                            !! energy change) of the shortwave that
                                                            !! should be absorbed by each layer.
   logical,                          intent(in)    :: absorbAllSW !< If true, apply heating above the
                                                            !! layers in which it should have occurred
                                                            !! to get the correct mean depth (and
                                                            !! potential energy change) of the
                                                            !! shortwave that should be absorbed by
                                                            !! each layer.
   real, dimension(SZI_(G),SZK_(GV)), intent(inout) :: T    !< Layer potential/conservative
                                                            !! temperatures [degC]
   real, dimension(max(1,nsw),SZI_(G)), intent(inout) :: Pen_SW_bnd !< Penetrating shortwave heating in
                                                            !! each band that hits the bottom and will
                                                            !! will be redistributed through the water
                                                            !! column [degC H ~> degC m or degC kg m-2],
                                                            !! size nsw x SZI_(G).
   real, dimension(SZI_(G),SZK_(GV)), optional, intent(in) :: eps !< Small thickness that must remain in
                                                            !! each layer, and which will not be
                                                            !! subject to heating [H ~> m or kg m-2]
   integer, dimension(SZI_(G),SZK_(GV)), optional, intent(in) :: ksort !< Density-sorted k-indicies.
   real, dimension(SZI_(G)), optional, intent(in)    :: htot !< Total mixed layer thickness [H ~> m or kg m-2].
   real, dimension(SZI_(G)), optional, intent(inout) :: Ttot !< Depth integrated mixed layer
                                                            !! temperature [degC H ~> degC m or degC kg m-2]
   real, dimension(SZI_(G),SZK_(GV)), optional, intent(in) :: dSV_dT !< The partial derivative of specific
                                                            !! volume with temperature [R-1 degC-1].
   real, dimension(SZI_(G),SZK_(GV)), optional, intent(inout) :: TKE !< The TKE sink from mixing the heating
                                                            !! throughout a layer [R Z3 T-2 ~> J m-2].
  
   ! Local variables
   real, dimension(SZI_(G),SZK_(GV)) :: &
     T_chg_above    ! A temperature change that will be applied to all the thick
                    ! layers above a given layer [degC].  This is only nonzero if
                    ! adjustAbsorptionProfile is true, in which case the net
                    ! change in the temperature of a layer is the sum of the
                    ! direct heating of that layer plus T_chg_above from all of
                    ! the layers below, plus any contribution from absorbing
                    ! radiation that hits the bottom.
   real, dimension(SZI_(G)) :: &
     h_heat, &      ! The thickness of the water column that will be heated by
                    ! any remaining shortwave radiation [H ~> m or kg m-2].
     t_chg, &       ! The temperature change of thick layers due to the remaining
                    ! shortwave radiation and contributions from T_chg_above [degC].
     pen_sw_rem     ! The sum across all wavelength bands of the penetrating shortwave
                    ! heating that hits the bottom and will be redistributed through
                    ! the water column [degC H ~> degC m or degC kg m-2]
   real :: SW_trans          ! fraction of shortwave radiation that is not
                             ! absorbed in a layer [nondim]
   real :: unabsorbed        ! fraction of the shortwave radiation that
                             ! is not absorbed because the layers are too thin
   real :: Ih_limit          ! inverse of the total depth at which the
                             ! surface fluxes start to be limited [H-1 ~> m-1 or m2 kg-1]
   real :: h_min_heat        ! minimum thickness layer that should get heated [H ~> m or kg m-2]
   real :: opt_depth         ! optical depth of a layer [nondim]
   real :: exp_OD            ! exp(-opt_depth) [nondim]
   real :: heat_bnd          ! heating due to absorption in the current
                             ! layer by the current band, including any piece that
                             ! is moved upward [degC H ~> degC m or degC kg m-2]
   real :: SWa               ! fraction of the absorbed shortwave that is
                             ! moved to layers above with adjustAbsorptionProfile [nondim]
   real :: coSWa_frac        ! The fraction of SWa that is actually moved upward.
   real :: min_SW_heat       ! A minimum remaining shortwave heating within a timestep that will be simply
                             ! absorbed in the next layer for computational efficiency, instead of
                             ! continuing to penetrate [degC H ~> degC m or degC kg m-2].
   real :: I_Habs            ! The inverse of the absorption length for a minimal flux [H-1 ~> m-1 or m2 kg-1]
   real :: epsilon           ! A small thickness that must remain in each
                             ! layer, and which will not be subject to heating [H ~> m or kg m-2]
   real :: g_Hconv2          ! A conversion factor for use in the TKE calculation
                             ! in units of [Z3 R2 T-2 H-2 ~> kg2 m-5 s-2 or m s-2].
   logical :: SW_Remains     ! If true, some column has shortwave radiation that
                             ! was not entirely absorbed.
   logical :: TKE_calc       ! If true, calculate the implications to the
                             ! TKE budget of the shortwave heating.
   real :: C1_6, C1_60
   integer :: is, ie, nz, i, k, ks, n
   sw_remains = .false.
  
   min_sw_heat = optics%PenSW_flux_absorb * dt
   i_habs = optics%PenSW_absorb_Invlen
  
   h_min_heat = 2.0*gv%Angstrom_H + gv%H_subroundoff
   is = g%isc ; ie = g%iec ; nz = g%ke
   c1_6 = 1.0 / 6.0 ; c1_60 = 1.0 / 60.0
  
   tke_calc = (present(tke) .and. present(dsv_dt))
  
   if (optics%answers_2018) then
     g_hconv2 = (us%L_to_Z**2*gv%g_Earth * gv%H_to_RZ) * gv%H_to_RZ
   else
     g_hconv2 = us%L_to_Z**2*gv%g_Earth * gv%H_to_RZ**2
   endif
  
   h_heat(:) = 0.0
   if (present(htot)) then ; do i=is,ie ; h_heat(i) = htot(i) ; enddo ; endif
  
   ! Apply penetrating SW radiation to remaining parts of layers.
   ! Excessively thin layers are not heated to avoid runaway temps.
   do ks=1,nz ; do i=is,ie
     k = ks
     if (present(ksort)) then
       if (ksort(i,ks) <= 0) cycle
       k = ksort(i,ks)
     endif
     epsilon = 0.0 ; if (present(eps)) epsilon = eps(i,k)
  
     t_chg_above(i,k) = 0.0
  
     if (h(i,k) > 1.5*epsilon) then
       do n=1,nsw ; if (pen_sw_bnd(n,i) > 0.0) then
         ! SW_trans is the SW that is transmitted THROUGH the layer
         opt_depth = h(i,k) * opacity_band(n,i,k)
         exp_od = exp(-opt_depth)
         sw_trans = exp_od
  
         ! Heating at a very small rate can be absorbed by a sufficiently thick layer or several
         ! thin layers without further penetration.
         if (optics%answers_2018) then
           if (nsw*pen_sw_bnd(n,i)*sw_trans < min_sw_heat*min(1.0, i_habs*h(i,k)) ) sw_trans = 0.0
         elseif ((nsw*pen_sw_bnd(n,i)*sw_trans < min_sw_heat) .and. (h(i,k) > h_min_heat)) then
           if (nsw*pen_sw_bnd(n,i) <= min_sw_heat * (i_habs*(h(i,k) - h_min_heat))) then
             sw_trans = 0.0
           else
             sw_trans = min(sw_trans, &
                            1.0 - (min_sw_heat*(i_habs*(h(i,k) - h_min_heat))) / (nsw*pen_sw_bnd(n,i)))
           endif
         endif
  
         heat_bnd = pen_sw_bnd(n,i) * (1.0 - sw_trans)
         if (adjustabsorptionprofile .and. (h_heat(i) > 0.0)) then
           !   In this case, a fraction of the heating is applied to the
           ! overlying water so that the mean pressure at which the shortwave
           ! heating occurs is exactly what it would have been with a careful
           ! pressure-weighted averaging of the exponential heating profile,
           ! hence there should be no TKE budget requirements due to this
           ! layer.  Very clever, but this is also limited so that the
           ! water above is not heated at a faster rate than the layer
           ! actually being heated, i.e., SWA <= h_heat / (h_heat + h(i,k))
           ! and takes the energetics of the rest of the heating into account.
           ! (-RWH, ~7 years later.)
           if (opt_depth > 1e-5) then
             swa = ((opt_depth + (opt_depth + 2.0)*exp_od) - 2.0) / &
               ((opt_depth + opacity_band(n,i,k) * h_heat(i)) * &
                (1.0 - exp_od))
           else
             ! Use Taylor series expansion of the expression above for a
             ! more accurate form with very small layer optical depths.
             swa = h(i,k) * (opt_depth * (1.0 - opt_depth)) / &
               ((h_heat(i) + h(i,k)) * (6.0 - 3.0*opt_depth))
           endif
           coswa_frac = 0.0
           if (swa*(h_heat(i) + h(i,k)) > h_heat(i)) then
             coswa_frac = (swa*(h_heat(i) + h(i,k)) - h_heat(i) ) / &
                          (swa*(h_heat(i) + h(i,k)))
             swa = h_heat(i) / (h_heat(i) + h(i,k))
           endif
  
           t_chg_above(i,k) = t_chg_above(i,k) + (swa * heat_bnd) / h_heat(i)
           t(i,k) = t(i,k) + ((1.0 - swa) * heat_bnd) / h(i,k)
         else
           coswa_frac = 1.0
           t(i,k) = t(i,k) + pen_sw_bnd(n,i) * (1.0 - sw_trans) / h(i,k)
         endif
  
         if (tke_calc) then
           if (opt_depth > 1e-2) then
             tke(i,k) = tke(i,k) - coswa_frac*heat_bnd*dsv_dt(i,k)* &
                (0.5*h(i,k)*g_hconv2) * &
                (opt_depth*(1.0+exp_od) - 2.0*(1.0-exp_od)) / (opt_depth*(1.0-exp_od))
           else
             ! Use Taylor series-derived approximation to the above expression
             ! that is well behaved and more accurate when opt_depth is small.
             tke(i,k) = tke(i,k) - coswa_frac*heat_bnd*dsv_dt(i,k)* &
                (0.5*h(i,k)*g_hconv2) * &
                (c1_6*opt_depth * (1.0 - c1_60*opt_depth**2))
           endif
         endif
  
         pen_sw_bnd(n,i) = pen_sw_bnd(n,i) * sw_trans
       endif ; enddo
     endif
  
     ! Add to the accumulated thickness above that could be heated.
     ! Only layers greater than h_min_heat thick should get heated.
     if (h(i,k) >= 2.0*h_min_heat) then
       h_heat(i) = h_heat(i) + h(i,k)
     elseif (h(i,k) > h_min_heat) then
       h_heat(i) = h_heat(i) + (2.0*h(i,k) - 2.0*h_min_heat)
     endif
   enddo ; enddo ! i & k loops
  
  
 ! if (.not.absorbAllSW .and. .not.adjustAbsorptionProfile) return
  
   ! Unless modified, there is no temperature change due to fluxes from the bottom.
   do i=is,ie ; t_chg(i) = 0.0 ; enddo
  
   if (absorballsw) then
     ! If there is still shortwave radiation at this point, it could go into
     ! the bottom (with a bottom mud model), or it could be redistributed back
     ! through the water column.
     do i=is,ie
       pen_sw_rem(i) = pen_sw_bnd(1,i)
       do n=2,nsw ; pen_sw_rem(i) = pen_sw_rem(i) + pen_sw_bnd(n,i) ; enddo
     enddo
     do i=is,ie ; if (pen_sw_rem(i) > 0.0) sw_remains = .true. ; enddo
  
     ih_limit = 1.0 / h_limit_fluxes
     do i=is,ie ; if ((pen_sw_rem(i) > 0.0) .and. (h_heat(i) > 0.0)) then
       if (h_heat(i)*ih_limit >= 1.0) then
         t_chg(i) = pen_sw_rem(i) / h_heat(i) ; unabsorbed = 0.0
       else
         t_chg(i) = pen_sw_rem(i) * ih_limit
         unabsorbed = 1.0 - h_heat(i)*ih_limit
       endif
       do n=1,nsw ; pen_sw_bnd(n,i) = unabsorbed * pen_sw_bnd(n,i) ; enddo
     endif ; enddo
   endif ! absorbAllSW
  
   if (absorballsw .or. adjustabsorptionprofile) then
     do ks=nz,1,-1 ; do i=is,ie
       k = ks
       if (present(ksort)) then
         if (ksort(i,ks) <= 0) cycle
         k = ksort(i,ks)
       endif
  
       if (t_chg(i) > 0.0) then
         ! Only layers greater than h_min_heat thick should get heated.
         if (h(i,k) >= 2.0*h_min_heat) then ; t(i,k) = t(i,k) + t_chg(i)
         elseif (h(i,k) > h_min_heat) then
           t(i,k) = t(i,k) + t_chg(i) * (2.0 - 2.0*h_min_heat/h(i,k))
         endif
       endif
       ! Increase the heating for layers above.
       t_chg(i) = t_chg(i) + t_chg_above(i,k)
     enddo ; enddo
     if (present(htot) .and. present(ttot)) then
       do i=is,ie ; ttot(i) = ttot(i) + t_chg(i) * htot(i) ; enddo
     endif
   endif ! absorbAllSW .or. adjustAbsorptionProfile
  

Referenced by mom_diabatic_aux::applyboundaryfluxesinout(), and mom_bulk_mixed_layer::bulkmixedlayer().

Here is the caller graph for this function:

◆ extract_optics_fields()

subroutine, public mom_opacity::extract_optics_fields	(	type(optics_type), intent(in)	optics,
		integer, intent(out), optional	nbands
	)

Set arguments to fields from the optics type.

Parameters

[in]	optics	An optics structure that has values of opacities and shortwave fluxes.
[out]	nbands	The number of penetrating bands of SW radiation

Definition at line 485 of file MOM_opacity.F90.

   type(optics_type),       intent(in)  :: optics !< An optics structure that has values of opacities
                                                  !! and shortwave fluxes.
   integer, optional,       intent(out) :: nbands !< The number of penetrating bands of SW radiation
  
   if (present(nbands)) nbands = optics%nbands
  

◆ extract_optics_slice()

subroutine, public mom_opacity::extract_optics_slice	(	type(optics_type), intent(in)	optics,
		integer, intent(in)	j,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		real, dimension(max(optics%nbands,1), g %isd: g %ied, gv %ke), intent(out), optional	opacity,
		real, intent(in), optional	opacity_scale,
		real, dimension(max(optics%nbands,1), g %isd: g %ied), intent(out), optional	penSW_top,
		real, intent(in), optional	penSW_scale
	)

This subroutine returns a 2-d slice at constant j of fields from an optics_type, with the potential for rescaling these fields.

Parameters

[in]	optics	An optics structure that has values of opacities and shortwave fluxes.
[in]	j	j-index to extract
[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[out]	opacity	The opacity in each band, i-point, and layer
[in]	opacity_scale	A factor by which to rescale the opacity.
[out]	pensw_top	The shortwave radiation [W m-2] at the surface
[in]	pensw_scale	A factor by which to rescale the shortwave flux.

Definition at line 447 of file MOM_opacity.F90.

   type(optics_type),       intent(in)  :: optics   !< An optics structure that has values of opacities
                                                    !! and shortwave fluxes.
   integer,                 intent(in)    :: j      !< j-index to extract
   type(ocean_grid_type),   intent(in)    :: G      !< The ocean's grid structure.
   type(verticalGrid_type), intent(in)    :: GV     !< The ocean's vertical grid structure.
   real, dimension(max(optics%nbands,1),SZI_(G),SZK_(GV)), &
                 optional, intent(out) :: opacity   !< The opacity in each band, i-point, and layer
   real, optional,         intent(in)  :: opacity_scale !< A factor by which to rescale the opacity.
   real, dimension(max(optics%nbands,1),SZI_(G)), &
                 optional, intent(out) :: penSW_top !< The shortwave radiation [W m-2] at the surface
                                                    !! in each of the nbands bands that penetrates
                                                    !! beyond the surface skin layer.
   real, optional,         intent(in)  :: penSW_scale !< A factor by which to rescale the shortwave flux.
  
   ! Local variables
   real :: scale_opacity, scale_penSW ! Rescaling factors
   integer :: i, is, ie, k, nz, n
   is = g%isc ; ie = g%iec ; nz = g%ke
  
   scale_opacity = 1.0 ; if (present(opacity_scale)) scale_opacity = opacity_scale
   scale_pensw = 1.0 ; if (present(pensw_scale)) scale_pensw = pensw_scale
  
   if (present(opacity)) then ; do k=1,nz ; do i=is,ie
     do n=1,optics%nbands
       opacity(n,i,k) = scale_opacity * optics%opacity_band(n,i,j,k)
     enddo
   enddo ; enddo ; endif
  
   if (present(pensw_top)) then ; do k=1,nz ; do i=is,ie
     do n=1,optics%nbands
       pensw_top(n,i) = scale_pensw * optics%SW_pen_band(n,i,j)
     enddo
   enddo ; enddo ; endif
  

Referenced by mom_bulk_mixed_layer::bulkmixedlayer(), and mom_forcing_type::extractfluxes1d().

Here is the caller graph for this function:

◆ opacity_end()

subroutine, public mom_opacity::opacity_end	(	type(opacity_cs), pointer	CS,
		type(optics_type), optional, pointer	optics
	)

Parameters

cs	An opacity control structure that should be deallocated.
optics	An optics type structure that should be deallocated.

Definition at line 1121 of file MOM_opacity.F90.

   type(opacity_CS),  pointer           :: CS !< An opacity control structure that should be deallocated.
   type(optics_type), optional, pointer :: optics !< An optics type structure that should be deallocated.
  
   if (associated(cs%id_opacity)) deallocate(cs%id_opacity)
   if (associated(cs)) deallocate(cs)
  
   if (present(optics)) then ; if (associated(optics)) then
     if (associated(optics%opacity_band)) deallocate(optics%opacity_band)
     if (associated(optics%sw_pen_band)) deallocate(optics%sw_pen_band)
   endif ; endif
  

◆ opacity_from_chl()

subroutine mom_opacity::opacity_from_chl	(	type(optics_type), intent(inout)	optics,
		real, dimension(:,:), pointer	sw_total,
		real, dimension(:,:), pointer	sw_vis_dir,
		real, dimension(:,:), pointer	sw_vis_dif,
		real, dimension(:,:), pointer	sw_nir_dir,
		real, dimension(:,:), pointer	sw_nir_dif,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(opacity_cs), pointer	CS,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(in), optional	chl_2d,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke), intent(in), optional	chl_3d
	)

private

This sets the "blue" band opacity based on chloophyll A concencentrations The red portion is lumped into the net heating at the surface.

Parameters

[in,out]	optics	An optics structure that has values set based on the opacities.
	sw_total	Total shortwave flux into the ocean [W m-2]
	sw_vis_dir	Visible, direct shortwave into the ocean [W m-2]
	sw_vis_dif	Visible, diffuse shortwave into the ocean [W m-2]
	sw_nir_dir	Near-IR, direct shortwave into the ocean [W m-2]
	sw_nir_dif	Near-IR, diffuse shortwave into the ocean [W m-2]
[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
	cs	The control structure.
[in]	chl_2d	Vertically uniform chlorophyll-A concentractions [mg m-3]
[in]	chl_3d	A 3-d field of chlorophyll-A concentractions [mg m-3]

Definition at line 222 of file MOM_opacity.F90.

   type(optics_type),       intent(inout) :: optics !< An optics structure that has values
                                                  !! set based on the opacities.
   real, dimension(:,:),    pointer       :: sw_total !< Total shortwave flux into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_vis_dir !< Visible, direct shortwave into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_vis_dif !< Visible, diffuse shortwave into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_nir_dir !< Near-IR, direct shortwave into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_nir_dif !< Near-IR, diffuse shortwave into the ocean [W m-2]
   type(ocean_grid_type),   intent(in)    :: G      !< The ocean's grid structure.
   type(verticalGrid_type), intent(in)    :: GV     !< The ocean's vertical grid structure.
   type(opacity_CS),        pointer       :: CS     !< The control structure.
   real, dimension(SZI_(G),SZJ_(G)), &
                  optional, intent(in)    :: chl_2d !< Vertically uniform chlorophyll-A concentractions [mg m-3]
   real, dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
                  optional, intent(in)    :: chl_3d !< A 3-d field of chlorophyll-A concentractions [mg m-3]
  
   real :: chl_data(SZI_(G),SZJ_(G)) ! The chlorophyll A concentrations in a layer [mg m-3].
   real :: Inv_nbands        ! The inverse of the number of bands of penetrating
                             ! shortwave radiation.
   real :: Inv_nbands_nir    ! The inverse of the number of bands of penetrating
                             ! near-infrafed radiation.
   real :: SW_pen_tot        ! The sum across the bands of the penetrating
                             ! shortwave radiation [W m-2].
   real :: SW_vis_tot        ! The sum across the visible bands of shortwave
                             ! radiation [W m-2].
   real :: SW_nir_tot        ! The sum across the near infrared bands of shortwave
                             ! radiation [W m-2].
   type(time_type) :: day
   character(len=128) :: mesg
   integer :: i, j, k, n, is, ie, js, je, nz, nbands
   logical :: multiband_vis_input, multiband_nir_input
  
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = gv%ke
  
 !   In this model, the Morel (modified) and Manizza (modified) schemes
 ! use the "blue" band in the parameterizations to determine the e-folding
 ! depth of the incoming shortwave attenuation. The red portion is lumped
 ! into the net heating at the surface.
 !
 ! Morel, A., Optical modeling of the upper ocean in relation to its biogenous
 !   matter content (case-i waters).,J. Geo. Res., {93}, 10,749--10,768, 1988.
 !
 ! Manizza, M., C.~L. Quere, A.~Watson, and E.~T. Buitenhuis, Bio-optical
 !   feedbacks among phytoplankton, upper ocean physics and sea-ice in a
 !   global model, Geophys. Res. Let., , L05,603, 2005.
  
   nbands = optics%nbands
  
   if (nbands <= 1) then ; inv_nbands = 1.0
   else ; inv_nbands = 1.0 / real(nbands) ; endif
  
   if (nbands <= 2) then ; inv_nbands_nir = 0.0
   else ; inv_nbands_nir = 1.0 / real(nbands - 2.0) ; endif
  
   multiband_vis_input = (associated(sw_vis_dir) .and. &
                          associated(sw_vis_dif))
   multiband_nir_input = (associated(sw_nir_dir) .and. &
                          associated(sw_nir_dif))
  
   chl_data(:,:) = 0.0
   if (present(chl_3d)) then
     do j=js,je ; do i=is,ie ; chl_data(i,j) = chl_3d(i,j,1) ; enddo ; enddo
     do k=1,nz; do j=js,je ; do i=is,ie
       if ((g%mask2dT(i,j) > 0.5) .and. (chl_3d(i,j,k) < 0.0)) then
         write(mesg,'(" Negative chl_3d of ",(1pe12.4)," found at i,j,k = ", &
                   & 3(1x,i3), " lon/lat = ",(1pe12.4)," E ", (1pe12.4), " N.")') &
                    chl_3d(i,j,k), i, j, k, g%geoLonT(i,j), g%geoLatT(i,j)
         call mom_error(fatal, "MOM_opacity opacity_from_chl: "//trim(mesg))
       endif
     enddo ; enddo ; enddo
   elseif (present(chl_2d)) then
     do j=js,je ; do i=is,ie ; chl_data(i,j) = chl_2d(i,j) ; enddo ; enddo
     do j=js,je ; do i=is,ie
       if ((g%mask2dT(i,j) > 0.5) .and. (chl_2d(i,j) < 0.0)) then
         write(mesg,'(" Negative chl_2d of ",(1pe12.4)," at i,j = ", &
                   & 2(i3), "lon/lat = ",(1pe12.4)," E ", (1pe12.4), " N.")') &
                    chl_data(i,j), i, j, g%geoLonT(i,j), g%geoLatT(i,j)
         call mom_error(fatal, "MOM_opacity opacity_from_chl: "//trim(mesg))
       endif
     enddo ; enddo
   else
     call mom_error(fatal, "Either chl_2d or chl_3d must be preesnt in a call to opacity_form_chl.")
   endif
  
   select case (cs%opacity_scheme)
     case (manizza_05)
       !$OMP parallel do default(shared) private(SW_vis_tot,SW_nir_tot)
       do j=js,je ; do i=is,ie
         sw_vis_tot = 0.0 ; sw_nir_tot = 0.0
         if (g%mask2dT(i,j) > 0.5) then
           if (multiband_vis_input) then
             sw_vis_tot = sw_vis_dir(i,j) + sw_vis_dif(i,j)
           else  ! Follow Manizza 05 in assuming that 42% of SW is visible.
             sw_vis_tot = 0.42 * sw_total(i,j)
           endif
           if (multiband_nir_input) then
             sw_nir_tot = sw_nir_dir(i,j) + sw_nir_dif(i,j)
           else
             sw_nir_tot = sw_total(i,j) - sw_vis_tot
           endif
         endif
  
         ! Band 1 is Manizza blue.
         optics%sw_pen_band(1,i,j) = cs%blue_frac*sw_vis_tot
         ! Band 2 (if used) is Manizza red.
         if (nbands > 1) &
           optics%sw_pen_band(2,i,j) = (1.0-cs%blue_frac)*sw_vis_tot
         ! All remaining bands are NIR, for lack of something better to do.
         do n=3,nbands
           optics%sw_pen_band(n,i,j) = inv_nbands_nir * sw_nir_tot
         enddo
       enddo ; enddo
     case (morel_88)
       !$OMP parallel do default(shared) private(SW_pen_tot)
       do j=js,je ; do i=is,ie
         sw_pen_tot = 0.0
         if (g%mask2dT(i,j) > 0.5) then ; if (multiband_vis_input) then
             sw_pen_tot = sw_pen_frac_morel(chl_data(i,j)) * &
                 (sw_vis_dir(i,j) + sw_vis_dif(i,j))
           else
             sw_pen_tot = sw_pen_frac_morel(chl_data(i,j)) * &
                 0.5*sw_total(i,j)
         endif ; endif
  
         do n=1,nbands
           optics%sw_pen_band(n,i,j) = inv_nbands*sw_pen_tot
         enddo
       enddo ; enddo
     case default
       call mom_error(fatal, "opacity_from_chl: CS%opacity_scheme is not valid.")
   end select
  
   !$OMP parallel do default(shared) firstprivate(chl_data)
   do k=1,nz
     if (present(chl_3d)) then
       do j=js,je ; do i=is,ie ; chl_data(i,j) = chl_3d(i,j,k) ; enddo ; enddo
     endif
  
     select case (cs%opacity_scheme)
       case (manizza_05)
         do j=js,je ; do i=is,ie
           if (g%mask2dT(i,j) <= 0.5) then
             do n=1,optics%nbands
               optics%opacity_band(n,i,j,k) = cs%opacity_land_value
             enddo
           else
             ! Band 1 is Manizza blue.
             optics%opacity_band(1,i,j,k) = 0.0232 + 0.074*chl_data(i,j)**0.674
             if (nbands >= 2) &  !  Band 2 is Manizza red.
               optics%opacity_band(2,i,j,k) = 0.225 + 0.037*chl_data(i,j)**0.629
             ! All remaining bands are NIR, for lack of something better to do.
             do n=3,nbands ; optics%opacity_band(n,i,j,k) = 2.86 ; enddo
           endif
         enddo ; enddo
       case (morel_88)
         do j=js,je ; do i=is,ie
           optics%opacity_band(1,i,j,k) = cs%opacity_land_value
           if (g%mask2dT(i,j) > 0.5) &
             optics%opacity_band(1,i,j,k) = opacity_morel(chl_data(i,j))
  
           do n=2,optics%nbands
             optics%opacity_band(n,i,j,k) = optics%opacity_band(1,i,j,k)
           enddo
         enddo ; enddo
  
       case default
         call mom_error(fatal, "opacity_from_chl: CS%opacity_scheme is not valid.")
     end select
   enddo
  
  

References manizza_05, mom_error_handler::mom_error(), morel_88, opacity_morel(), and sw_pen_frac_morel().

Referenced by set_opacity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ opacity_init()

subroutine, public mom_opacity::opacity_init	(	type(time_type), intent(in), target	Time,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(unit_scale_type), intent(in)	US,
		type(param_file_type), intent(in)	param_file,
		type(diag_ctrl), intent(inout), target	diag,
		type(opacity_cs), pointer	CS,
		type(optics_type), pointer	optics
	)

This routine initalizes the opacity module, including an optics_type.

Parameters

[in]	time	The current model time.
[in]	g	The ocean's grid structure.
[in]	gv	model vertical grid structure
[in]	us	A dimensional unit scaling type
[in]	param_file	A structure to parse for run-time parameters.
[in,out]	diag	A structure that is used to regulate diagnostic output.
	cs	A pointer that is set to point to the control structure for this module.
	optics	An optics structure that has parameters set and arrays allocated here.

Definition at line 922 of file MOM_opacity.F90.

   type(time_type), target, intent(in)    :: Time !< The current model time.
   type(ocean_grid_type),   intent(in)    :: G    !< The ocean's grid structure.
   type(verticalGrid_type), intent(in)    :: GV   !< model vertical grid structure
   type(unit_scale_type),   intent(in)    :: US   !< A dimensional unit scaling type
   type(param_file_type),   intent(in)    :: param_file !< A structure to parse for run-time
                                                  !! parameters.
   type(diag_ctrl), target, intent(inout) :: diag !< A structure that is used to regulate diagnostic
                                                  !! output.
   type(opacity_CS),        pointer       :: CS   !< A pointer that is set to point to the control
                                                  !! structure for this module.
   type(optics_type),       pointer       :: optics !< An optics structure that has parameters
                                                  !! set and arrays allocated here.
   ! Local variables
   character(len=200) :: tmpstr
   character(len=40)  :: mdl = "MOM_opacity"
   character(len=40)  :: bandnum, shortname
   character(len=200) :: longname
   character(len=40)  :: scheme_string
   ! This include declares and sets the variable "version".
 # include "version_variable.h"
   real :: PenSW_absorb_minthick ! A thickness that is used to absorb the remaining shortwave heat
                                 ! flux when that flux drops below PEN_SW_FLUX_ABSORB [m].
   real :: PenSW_minthick_dflt ! The default for PenSW_absorb_minthick [m]
   logical :: default_2018_answers
   logical :: use_scheme
   integer :: isd, ied, jsd, jed, nz, n
   isd = g%isd ; ied = g%ied ; jsd = g%jsd ; jed = g%jed ; nz = g%ke
  
   if (associated(cs)) then
     call mom_error(warning, "opacity_init called with an associated"// &
                              "associated control structure.")
     return
   else ; allocate(cs) ; endif
  
   cs%diag => diag
  
   ! Read all relevant parameters and write them to the model log.
   call log_version(param_file, mdl, version, '')
  
 ! parameters for CHL_A routines
   call get_param(param_file, mdl, "VAR_PEN_SW", cs%var_pen_sw, &
                  "If true, use one of the CHL_A schemes specified by "//&
                  "OPACITY_SCHEME to determine the e-folding depth of "//&
                  "incoming short wave radiation.", default=.false.)
  
   cs%opacity_scheme = no_scheme ; scheme_string = ''
   if (cs%var_pen_sw) then
     call get_param(param_file, mdl, "OPACITY_SCHEME", tmpstr, &
                  "This character string specifies how chlorophyll "//&
                  "concentrations are translated into opacities. Currently "//&
                  "valid options include:\n"//&
                  " \t\t  MANIZZA_05 - Use Manizza et al., GRL, 2005. \n"//&
                  " \t\t  MOREL_88 - Use Morel, JGR, 1988.", &
                  default=manizza_05_string)
     if (len_trim(tmpstr) > 0) then
       tmpstr = uppercase(tmpstr)
       select case (tmpstr)
         case (manizza_05_string)
           cs%opacity_scheme = manizza_05 ; scheme_string = manizza_05_string
         case (morel_88_string)
           cs%opacity_scheme = morel_88 ; scheme_string = morel_88_string
         case default
           call mom_error(fatal, "opacity_init: #DEFINE OPACITY_SCHEME "//&
                                   trim(tmpstr) // "in input file is invalid.")
       end select
       call mom_mesg('opacity_init: opacity scheme set to "'//trim(tmpstr)//'".', 5)
     endif
     if (cs%opacity_scheme == no_scheme) then
       call mom_error(warning, "opacity_init: No scheme has successfully "//&
                "been specified for the opacity.  Using the default MANIZZA_05.")
       cs%opacity_scheme = manizza_05 ; scheme_string = manizza_05_string
     endif
  
     call get_param(param_file, mdl, "BLUE_FRAC_SW", cs%blue_frac, &
                  "The fraction of the penetrating shortwave radiation "//&
                  "that is in the blue band.", default=0.5, units="nondim")
   else
     call get_param(param_file, mdl, "EXP_OPACITY_SCHEME", tmpstr, &
                  "This character string specifies which exponential "//&
                  "opacity scheme to utilize. Currently "//&
                  "valid options include:\n"//&
                  " \t\t  SINGLE_EXP - Single Exponent decay. \n"//&
                  " \t\t  DOUBLE_EXP - Double Exponent decay.", &
                  default=single_exp_string)!New default for "else" above (non-Chl scheme)
     if (len_trim(tmpstr) > 0) then
       tmpstr = uppercase(tmpstr)
       select case (tmpstr)
         case (single_exp_string)
           cs%opacity_scheme = single_exp ; scheme_string = single_exp_string
         case (double_exp_string)
           cs%opacity_scheme = double_exp ; scheme_string = double_exp_string
       end select
       call mom_mesg('opacity_init: opacity scheme set to "'//trim(tmpstr)//'".', 5)
     endif
     call get_param(param_file, mdl, "PEN_SW_SCALE", cs%pen_sw_scale, &
                  "The vertical absorption e-folding depth of the "//&
                  "penetrating shortwave radiation.", units="m", default=0.0)
     !BGR/ Added for opacity_scheme==double_exp read in 2nd exp-decay and fraction
     if (cs%Opacity_scheme == double_exp ) then
       call get_param(param_file, mdl, "PEN_SW_SCALE_2ND", cs%pen_sw_scale_2nd, &
                  "The (2nd) vertical absorption e-folding depth of the "//&
                  "penetrating shortwave radiation "//&
                  "(use if SW_EXP_MODE==double.)",&
                  units="m", default=0.0)
       call get_param(param_file, mdl, "SW_1ST_EXP_RATIO", cs%sw_1st_exp_ratio, &
                  "The fraction of 1st vertical absorption e-folding depth "//&
                  "penetrating shortwave radiation if SW_EXP_MODE==double.",&
                   units="m", default=0.0)
     elseif (cs%OPACITY_SCHEME == single_exp) then
       !/Else disable 2nd_exp scheme
       cs%pen_sw_scale_2nd = 0.0
       cs%sw_1st_exp_ratio = 1.0
     endif
     call get_param(param_file, mdl, "PEN_SW_FRAC", cs%pen_sw_frac, &
                  "The fraction of the shortwave radiation that penetrates "//&
                  "below the surface.", units="nondim", default=0.0)
  
   endif
   call get_param(param_file, mdl, "PEN_SW_NBANDS", optics%nbands, &
                  "The number of bands of penetrating shortwave radiation.", &
                  default=1)
   if (cs%Opacity_scheme == double_exp ) then
     if (optics%nbands /= 2) call mom_error(fatal, &
         "set_opacity: \Cannot use a double_exp opacity scheme with nbands!=2.")
   elseif (cs%Opacity_scheme == single_exp ) then
     if (optics%nbands /= 1) call mom_error(fatal, &
         "set_opacity: \Cannot use a single_exp opacity scheme with nbands!=1.")
   endif
  
   call get_param(param_file, mdl, "DEFAULT_2018_ANSWERS", default_2018_answers, &
                  "This sets the default value for the various _2018_ANSWERS parameters.", &
                  default=.true.)
   call get_param(param_file, mdl, "OPTICS_2018_ANSWERS", optics%answers_2018, &
                  "If true, use the order of arithmetic and expressions that recover the "//&
                  "answers from the end of 2018.  Otherwise, use updated expressions for "//&
                  "handling the absorption of small remaining shortwave fluxes.", &
                  default=default_2018_answers)
  
   call get_param(param_file, mdl, "PEN_SW_FLUX_ABSORB", optics%PenSW_flux_absorb, &
                  "A minimum remaining shortwave heating rate that will be simply absorbed in "//&
                  "the next sufficiently thick layers for computational efficiency, instead of "//&
                  "continuing to penetrate.  The default, 2.5e-11 degC m s-1, is about 1e-4 W m-2 "//&
                  "or 0.08 degC m century-1, but 0 is also a valid value.", &
                  default=2.5e-11, units="degC m s-1", scale=gv%m_to_H*us%T_to_s)
  
   if (optics%answers_2018) then ; pensw_minthick_dflt = 0.001 ; else ; pensw_minthick_dflt = 1.0 ; endif
   call get_param(param_file, mdl, "PEN_SW_ABSORB_MINTHICK", pensw_absorb_minthick, &
                  "A thickness that is used to absorb the remaining penetrating shortwave heat "//&
                  "flux when it drops below PEN_SW_FLUX_ABSORB.", &
                  default=pensw_minthick_dflt, units="m", scale=gv%m_to_H)
   optics%PenSW_absorb_Invlen = 1.0 / (pensw_absorb_minthick + gv%H_subroundoff)
  
   if (.not.associated(optics%min_wavelength_band)) &
     allocate(optics%min_wavelength_band(optics%nbands))
   if (.not.associated(optics%max_wavelength_band)) &
     allocate(optics%max_wavelength_band(optics%nbands))
  
   if (cs%opacity_scheme == manizza_05) then
     optics%min_wavelength_band(1) =0
     optics%max_wavelength_band(1) =550
     if (optics%nbands >= 2) then
       optics%min_wavelength_band(2)=550
       optics%max_wavelength_band(2)=700
     endif
     if (optics%nbands > 2) then
       do n=3,optics%nbands
         optics%min_wavelength_band(n) =700
         optics%max_wavelength_band(n) =2800
       enddo
     endif
   endif
  
   call get_param(param_file, mdl, "OPACITY_LAND_VALUE", cs%opacity_land_value, &
                  "The value to use for opacity over land. The default is "//&
                  "10 m-1 - a value for muddy water.", units="m-1", default=10.0)
  
   if (.not.associated(optics%opacity_band)) &
     allocate(optics%opacity_band(optics%nbands,isd:ied,jsd:jed,nz))
   if (.not.associated(optics%sw_pen_band)) &
     allocate(optics%sw_pen_band(optics%nbands,isd:ied,jsd:jed))
   allocate(cs%id_opacity(optics%nbands)) ; cs%id_opacity(:) = -1
  
   cs%id_sw_pen = register_diag_field('ocean_model', 'SW_pen', diag%axesT1, time, &
       'Penetrating shortwave radiation flux into ocean', 'W m-2')
   cs%id_sw_vis_pen = register_diag_field('ocean_model', 'SW_vis_pen', diag%axesT1, time, &
       'Visible penetrating shortwave radiation flux into ocean', 'W m-2')
   do n=1,optics%nbands
     write(bandnum,'(i3)') n
     shortname = 'opac_'//trim(adjustl(bandnum))
     longname = 'Opacity for shortwave radiation in band '//trim(adjustl(bandnum)) &
       // ', saved as L^-1 tanh(Opacity * L) for L = 10^-10 m'
     cs%id_opacity(n) = register_diag_field('ocean_model', shortname, diag%axesTL, time, &
       longname, 'm-1')
   enddo
  

References double_exp, double_exp_string, manizza_05, manizza_05_string, mom_error_handler::mom_error(), mom_error_handler::mom_mesg(), morel_88, morel_88_string, no_scheme, mom_diag_mediator::register_diag_field(), single_exp, single_exp_string, and mom_string_functions::uppercase().

Here is the call graph for this function:

◆ opacity_manizza()

real function, public mom_opacity::opacity_manizza ( real, intent(in) chl_data )

This sets the blue-wavelength opacity according to the scheme proposed by Manizza, M. et al, 2005.

Parameters

[in] chl_data The chlorophyll-A concentration in mg m-3.

Returns: The returned opacity [m-1]

Definition at line 437 of file MOM_opacity.F90.

   real, intent(in)  :: chl_data !< The chlorophyll-A concentration in mg m-3.
   real :: opacity_manizza !< The returned opacity [m-1]
 !   This sets the blue-wavelength opacity according to the scheme proposed by Manizza, M. et al, 2005.
  
   opacity_manizza = 0.0232 + 0.074*chl_data**0.674

◆ opacity_morel()

real function, public mom_opacity::opacity_morel ( real, intent(in) chl_data )

This sets the blue-wavelength opacity according to the scheme proposed by Morel and Antoine (1994).

Parameters

[in] chl_data The chlorophyll-A concentration in mg m-3.

Returns: The returned opacity [m-1]

Definition at line 397 of file MOM_opacity.F90.

   real, intent(in)  :: chl_data !< The chlorophyll-A concentration in mg m-3.
   real :: opacity_morel !< The returned opacity [m-1]
  
   !   The following are coefficients for the optical model taken from Morel and
   ! Antoine (1994). These coeficients represent a non uniform distribution of
   ! chlorophyll-a through the water column.  Other approaches may be more
   ! appropriate when using an interactive ecosystem model that predicts
   ! three-dimensional chl-a values.
   real, dimension(6), parameter :: &
        Z2_coef=(/7.925, -6.644, 3.662, -1.815, -0.218,  0.502/)
   real :: Chl, Chl2 ! The log10 of chl_data (in mg m-3), and Chl^2.
  
   chl = log10(min(max(chl_data,0.02),60.0)) ; chl2 = chl*chl
   opacity_morel = 1.0 / ( (z2_coef(1) + z2_coef(2)*chl) + chl2 * &
       ((z2_coef(3) + chl*z2_coef(4)) + chl2*(z2_coef(5) + chl*z2_coef(6))) )

Referenced by opacity_from_chl().

Here is the caller graph for this function:

◆ optics_nbands()

integer function, public mom_opacity::optics_nbands ( type(optics_type), intent(in) optics )

Return the number of bands of penetrating shortwave radiation.

Parameters

[in] optics An optics structure that has values of opacities and shortwave fluxes.

Returns: The number of penetrating bands of SW radiation

Definition at line 495 of file MOM_opacity.F90.

   type(optics_type),       intent(in)  :: optics !< An optics structure that has values of opacities
                                                  !! and shortwave fluxes.
   integer :: optics_nbands !< The number of penetrating bands of SW radiation
  
   optics_nbands = optics%nbands

Referenced by mom_forcing_type::calculatebuoyancyflux1d(), mom_forcing_type::calculatebuoyancyflux2d(), mom_diabatic_driver::diabatic_ale(), mom_diabatic_driver::diabatic_ale_legacy(), and mom_forcing_type::extractfluxes1d().

Here is the caller graph for this function:

◆ set_opacity()

subroutine, public mom_opacity::set_opacity	(	type(optics_type), intent(inout)	optics,
		real, dimension(:,:), pointer	sw_total,
		real, dimension(:,:), pointer	sw_vis_dir,
		real, dimension(:,:), pointer	sw_vis_dif,
		real, dimension(:,:), pointer	sw_nir_dir,
		real, dimension(:,:), pointer	sw_nir_dif,
		type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(opacity_cs), pointer	CS,
		real, dimension( g %isd: g %ied, g %jsd: g %jed), intent(in), optional	chl_2d,
		real, dimension( g %isd: g %ied, g %jsd: g %jed, gv %ke), intent(in), optional	chl_3d
	)

This sets the opacity of sea water based based on one of several different schemes.

Parameters

[in,out]	optics	An optics structure that has values set based on the opacities.
	sw_total	Total shortwave flux into the ocean [W m-2]
	sw_vis_dir	Visible, direct shortwave into the ocean [W m-2]
	sw_vis_dif	Visible, diffuse shortwave into the ocean [W m-2]
	sw_nir_dir	Near-IR, direct shortwave into the ocean [W m-2]
	sw_nir_dif	Near-IR, diffuse shortwave into the ocean [W m-2]
[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
	cs	The control structure earlier set up by opacity_init.
[in]	chl_2d	Vertically uniform chlorophyll-A concentractions[mg m-3]
[in]	chl_3d	The chlorophyll-A concentractions of each layer [mg m-3]

Definition at line 93 of file MOM_opacity.F90.

   type(optics_type),       intent(inout) :: optics !< An optics structure that has values
                                                    !! set based on the opacities.
   real, dimension(:,:),    pointer       :: sw_total !< Total shortwave flux into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_vis_dir !< Visible, direct shortwave into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_vis_dif !< Visible, diffuse shortwave into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_nir_dir !< Near-IR, direct shortwave into the ocean [W m-2]
   real, dimension(:,:),    pointer       :: sw_nir_dif !< Near-IR, diffuse shortwave into the ocean [W m-2]
   type(ocean_grid_type),   intent(in)    :: G      !< The ocean's grid structure.
   type(verticalGrid_type), intent(in)    :: GV     !< The ocean's vertical grid structure.
   type(opacity_CS),        pointer       :: CS     !< The control structure earlier set up by
                                                    !! opacity_init.
   real, dimension(SZI_(G),SZJ_(G)), &
                  optional, intent(in)    :: chl_2d !< Vertically uniform chlorophyll-A concentractions[mg m-3]
   real, dimension(SZI_(G),SZJ_(G),SZK_(GV)), &
                  optional, intent(in)    :: chl_3d !< The chlorophyll-A concentractions of each layer [mg m-3]
  
   ! Local variables
   integer :: i, j, k, n, is, ie, js, je, nz
   real :: inv_sw_pen_scale  ! The inverse of the e-folding scale [m-1].
   real :: Inv_nbands        ! The inverse of the number of bands of penetrating
                             ! shortwave radiation.
   logical :: call_for_surface  ! if horizontal slice is the surface layer
   real :: tmp(SZI_(G),SZJ_(G),SZK_(GV)) ! A 3-d temporary array.
   real :: chl(SZI_(G),SZJ_(G),SZK_(GV)) ! The concentration of chlorophyll-A [mg m-3].
   real :: Pen_SW_tot(SZI_(G),SZJ_(G))   ! The penetrating shortwave radiation
                                         ! summed across all bands [W m-2].
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = gv%ke
  
   if (.not. associated(cs)) call mom_error(fatal, "set_opacity: "// &
          "Module must be initialized via opacity_init before it is used.")
  
   if (present(chl_2d) .or. present(chl_3d)) then
     ! The optical properties are based on cholophyll concentrations.
     call opacity_from_chl(optics, sw_total, sw_vis_dir, sw_vis_dif, sw_nir_dir, sw_nir_dif, &
                           g, gv, cs, chl_2d, chl_3d)
   else ! Use sw e-folding scale set by MOM_input
     if (optics%nbands <= 1) then ; inv_nbands = 1.0
     else ; inv_nbands = 1.0 / real(optics%nbands) ; endif
  
     ! Make sure there is no division by 0.
     inv_sw_pen_scale = 1.0 / max(cs%pen_sw_scale, 0.1*gv%Angstrom_m, &
                                  gv%H_to_m*gv%H_subroundoff)
     if ( cs%Opacity_scheme == double_exp ) then
       !$OMP parallel do default(shared)
       do k=1,nz ; do j=js,je ; do i=is,ie
         optics%opacity_band(1,i,j,k) = inv_sw_pen_scale
         optics%opacity_band(2,i,j,k) = 1.0 / max(cs%pen_sw_scale_2nd, &
              0.1*gv%Angstrom_m,gv%H_to_m*gv%H_subroundoff)
       enddo ; enddo ; enddo
       if (.not.associated(sw_total) .or. (cs%pen_SW_scale <= 0.0)) then
         !$OMP parallel do default(shared)
         do j=js,je ; do i=is,ie ; do n=1,optics%nbands
           optics%sw_pen_band(n,i,j) = 0.0
         enddo ; enddo ; enddo
       else
         !$OMP parallel do default(shared)
         do j=js,je ; do i=is,ie
           optics%sw_pen_band(1,i,j) = (cs%SW_1st_EXP_RATIO) * sw_total(i,j)
           optics%sw_pen_band(2,i,j) = (1.-cs%SW_1st_EXP_RATIO) * sw_total(i,j)
         enddo ; enddo
       endif
     else
       do k=1,nz ; do j=js,je ; do i=is,ie  ; do n=1,optics%nbands
         optics%opacity_band(n,i,j,k) = inv_sw_pen_scale
       enddo ; enddo ; enddo ; enddo
       if (.not.associated(sw_total) .or. (cs%pen_SW_scale <= 0.0)) then
         !$OMP parallel do default(shared)
         do j=js,je ; do i=is,ie ; do n=1,optics%nbands
           optics%sw_pen_band(n,i,j) = 0.0
         enddo ; enddo ; enddo
       else
         !$OMP parallel do default(shared)
         do j=js,je ; do i=is,ie ; do n=1,optics%nbands
           optics%sw_pen_band(n,i,j) = cs%pen_SW_frac * inv_nbands * sw_total(i,j)
         enddo ; enddo ; enddo
       endif
     endif
   endif
  
   if (query_averaging_enabled(cs%diag)) then
     if (cs%id_sw_pen > 0) then
       !$OMP parallel do default(shared)
       do j=js,je ; do i=is,ie
         pen_sw_tot(i,j) = 0.0
         do n=1,optics%nbands
           pen_sw_tot(i,j) = pen_sw_tot(i,j) + optics%sw_pen_band(n,i,j)
         enddo
       enddo ; enddo
       call post_data(cs%id_sw_pen, pen_sw_tot, cs%diag)
     endif
     if (cs%id_sw_vis_pen > 0) then
       if (cs%opacity_scheme == manizza_05) then
         !$OMP parallel do default(shared)
         do j=js,je ; do i=is,ie
           pen_sw_tot(i,j) = 0.0
           do n=1,min(optics%nbands,2)
             pen_sw_tot(i,j) = pen_sw_tot(i,j) + optics%sw_pen_band(n,i,j)
           enddo
         enddo ; enddo
       else
         !$OMP parallel do default(shared)
         do j=js,je ; do i=is,ie
           pen_sw_tot(i,j) = 0.0
           do n=1,optics%nbands
             pen_sw_tot(i,j) = pen_sw_tot(i,j) + optics%sw_pen_band(n,i,j)
           enddo
         enddo ; enddo
       endif
       call post_data(cs%id_sw_vis_pen, pen_sw_tot, cs%diag)
     endif
     do n=1,optics%nbands ; if (cs%id_opacity(n) > 0) then
       !$OMP parallel do default(shared)
       do k=1,nz ; do j=js,je ; do i=is,ie
         ! Remap opacity (op) to 1/L * tanh(op * L) where L is one Angstrom.
         ! This gives a nearly identical value when op << 1/L but allows one to
         ! store the values when opacity is divergent (i.e. opaque).
         tmp(i,j,k) = tanh(op_diag_len * optics%opacity_band(n,i,j,k)) / op_diag_len
       enddo ; enddo ; enddo
       call post_data(cs%id_opacity(n), tmp, cs%diag)
     endif ; enddo
   endif
  

References double_exp, manizza_05, mom_error_handler::mom_error(), op_diag_len, opacity_from_chl(), and mom_diag_mediator::query_averaging_enabled().

Here is the call graph for this function:

◆ sumswoverbands()

subroutine, public mom_opacity::sumswoverbands	(	type(ocean_grid_type), intent(in)	G,
		type(verticalgrid_type), intent(in)	GV,
		type(unit_scale_type), intent(in)	US,
		real, dimension( g %isd: g %ied, gv %ke), intent(in)	h,
		integer, intent(in)	nsw,
		type(optics_type), intent(in)	optics,
		integer, intent(in)	j,
		real, intent(in)	dt,
		real, intent(in)	H_limit_fluxes,
		logical, intent(in)	absorbAllSW,
		real, dimension(max(nsw,1), g %isd: g %ied), intent(in)	iPen_SW_bnd,
		real, dimension( g %isd: g %ied, gv %ke+1), intent(inout)	netPen
	)

This subroutine calculates the total shortwave heat flux integrated over bands as a function of depth. This routine is only called for computing buoyancy fluxes for use in KPP. This routine does not updat e the state.

Parameters

[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[in]	us	A dimensional unit scaling type
[in]	h	Layer thicknesses [H ~> m or kg m-2].
[in]	nsw	The number of bands of penetrating shortwave radiation, perhaps from optics_nbands(optics),
[in]	optics	An optics structure that has values set based on the opacities.
[in]	j	j-index to work on.
[in]	dt	Time step [T ~> s].
[in]	h_limit_fluxes	the total depth at which the surface fluxes start to be limited to avoid excessive heating of a thin ocean [H ~> m or kg m-2]
[in]	absorballsw	If true, ensure that all shortwave radiation is absorbed in the ocean water column.
[in]	ipen_sw_bnd	The incident penetrating shortwave heating in each band that hits the bottom and will be redistributed through the water column [degC H ~> degC m or degC kg m-2]; size nsw x G isd: G ied.
[in,out]	netpen	Net penetrating shortwave heat flux at each

Definition at line 783 of file MOM_opacity.F90.

   type(ocean_grid_type),    intent(in)    :: G   !< The ocean's grid structure.
   type(verticalGrid_type),  intent(in)    :: GV  !< The ocean's vertical grid structure.
   type(unit_scale_type),    intent(in)    :: US    !< A dimensional unit scaling type
   real, dimension(SZI_(G),SZK_(GV)), &
                             intent(in)    :: h   !< Layer thicknesses [H ~> m or kg m-2].
   integer,                  intent(in)    :: nsw !< The number of bands of penetrating shortwave
                                                  !! radiation, perhaps from optics_nbands(optics),
   type(optics_type),        intent(in)    :: optics !< An optics structure that has values
                                                    !! set based on the opacities.
   integer,                  intent(in)    :: j   !< j-index to work on.
   real,                     intent(in)    :: dt  !< Time step [T ~> s].
   real,                     intent(in)    :: H_limit_fluxes !< the total depth at which the
                                                  !! surface fluxes start to be limited to avoid
                                                  !! excessive heating of a thin ocean [H ~> m or kg m-2]
   logical,                  intent(in)    :: absorbAllSW !< If true, ensure that all shortwave
                                                  !! radiation is absorbed in the ocean water column.
   real, dimension(max(nsw,1),SZI_(G)), intent(in) :: iPen_SW_bnd !< The incident penetrating shortwave
                                                  !! heating in each band that hits the bottom and
                                                  !! will be redistributed through the water column
                                                  !! [degC H ~> degC m or degC kg m-2]; size nsw x SZI_(G).
   real, dimension(SZI_(G),SZK_(GV)+1), &
                              intent(inout) :: netPen !< Net penetrating shortwave heat flux at each
                                                  !! interface, summed across all bands
                                                  !! [degC H ~> degC m or degC kg m-2].
   ! Local variables
   real :: h_heat(SZI_(G))     ! thickness of the water column that receives
                               ! remaining shortwave radiation [H ~> m or kg m-2].
   real :: Pen_SW_rem(SZI_(G)) ! sum across all wavelength bands of the
                               ! penetrating shortwave heating that hits the bottom
                               ! and will be redistributed through the water column
                               ! [degC H ~> degC m or degC kg m-2]
  
   real, dimension(max(nsw,1),SZI_(G)) :: Pen_SW_bnd ! The remaining penetrating shortwave radiation
                           ! in each band, initially iPen_SW_bnd [degC H ~> degC m or degC kg m-2]
   real :: SW_trans        ! fraction of shortwave radiation not
                           ! absorbed in a layer [nondim]
   real :: unabsorbed      ! fraction of the shortwave radiation
                           ! not absorbed because the layers are too thin.
   real :: Ih_limit        ! inverse of the total depth at which the
                           ! surface fluxes start to be limited [H-1 ~> m-1 or m2 kg-1]
   real :: min_SW_heat     ! A minimum remaining shortwave heating within a timestep that will be simply
                           ! absorbed in the next layer for computational efficiency, instead of
                           ! continuing to penetrate [degC H ~> degC m or degC kg m-2].
   real :: I_Habs            ! The inverse of the absorption length for a minimal flux [H-1 ~> m-1 or m2 kg-1]
   real :: h_min_heat      ! minimum thickness layer that should get heated [H ~> m or kg m-2]
   real :: opt_depth       ! optical depth of a layer [nondim]
   real :: exp_OD          ! exp(-opt_depth) [nondim]
   logical :: SW_Remains   ! If true, some column has shortwave radiation that
                           ! was not entirely absorbed.
  
   integer :: is, ie, nz, i, k, ks, n
   sw_remains = .false.
  
   min_sw_heat = optics%PenSW_flux_absorb*dt ! Default of 2.5e-11*US%T_to_s*GV%m_to_H
   i_habs = 1e3*gv%H_to_m ! optics%PenSW_absorb_Invlen
  
   h_min_heat = 2.0*gv%Angstrom_H + gv%H_subroundoff
   is = g%isc ; ie = g%iec ; nz = g%ke
  
   pen_sw_bnd(:,:) = ipen_sw_bnd(:,:)
   do i=is,ie ; h_heat(i) = 0.0 ; enddo
   do i=is,ie
     netpen(i,1) = 0.
     do n=1,max(nsw,1)
       netpen(i,1) = netpen(i,1) + pen_sw_bnd(n,i)   ! Surface interface
     enddo
   enddo
  
   ! Apply penetrating SW radiation to remaining parts of layers.
   ! Excessively thin layers are not heated to avoid runaway temps.
   do k=1,nz
  
     do i=is,ie
       netpen(i,k+1) = 0.
  
       if (h(i,k) > 0.0) then
         do n=1,nsw ; if (pen_sw_bnd(n,i) > 0.0) then
           ! SW_trans is the SW that is transmitted THROUGH the layer
           opt_depth = h(i,k)*gv%H_to_m * optics%opacity_band(n,i,j,k)
           exp_od = exp(-opt_depth)
           sw_trans = exp_od
  
           ! Heating at a very small rate can be absorbed by a sufficiently thick layer or several
           ! thin layers without further penetration.
           if (optics%answers_2018) then
             if (nsw*pen_sw_bnd(n,i)*sw_trans < min_sw_heat*min(1.0, i_habs*h(i,k)) ) sw_trans = 0.0
           elseif ((nsw*pen_sw_bnd(n,i)*sw_trans < min_sw_heat) .and. (h(i,k) > h_min_heat)) then
             if (nsw*pen_sw_bnd(n,i) <= min_sw_heat * (i_habs*(h(i,k) - h_min_heat))) then
               sw_trans = 0.0
             else
               sw_trans = min(sw_trans, &
                              1.0 - (min_sw_heat*(i_habs*(h(i,k) - h_min_heat))) / (nsw*pen_sw_bnd(n,i)))
             endif
           endif
  
           pen_sw_bnd(n,i) = pen_sw_bnd(n,i) * sw_trans
           netpen(i,k+1)   = netpen(i,k+1) + pen_sw_bnd(n,i)
         endif ; enddo
       endif ! h(i,k) > 0.0
  
       ! Add to the accumulated thickness above that could be heated.
       ! Only layers greater than h_min_heat thick should get heated.
       if (h(i,k) >= 2.0*h_min_heat) then
         h_heat(i) = h_heat(i) + h(i,k)
       elseif (h(i,k) > h_min_heat) then
         h_heat(i) = h_heat(i) + (2.0*h(i,k) - 2.0*h_min_heat)
       endif
     enddo ! i loop
   enddo ! k loop
  
   if (absorballsw) then
  
     ! If there is still shortwave radiation at this point, it could go into
     ! the bottom (with a bottom mud model), or it could be redistributed back
     ! through the water column.
     do i=is,ie
       pen_sw_rem(i) = pen_sw_bnd(1,i)
       do n=2,nsw ; pen_sw_rem(i) = pen_sw_rem(i) + pen_sw_bnd(n,i) ; enddo
     enddo
     do i=is,ie ; if (pen_sw_rem(i) > 0.0) sw_remains = .true. ; enddo
  
     ih_limit = 1.0 / h_limit_fluxes
     do i=is,ie ; if ((pen_sw_rem(i) > 0.0) .and. (h_heat(i) > 0.0)) then
       if (h_heat(i)*ih_limit < 1.0) then
         unabsorbed = 1.0 - h_heat(i)*ih_limit
       else
         unabsorbed = 0.0
       endif
       do n=1,nsw ; pen_sw_bnd(n,i) = unabsorbed * pen_sw_bnd(n,i) ; enddo
     endif ; enddo
  
   endif ! absorbAllSW
  

Referenced by mom_forcing_type::calculatebuoyancyflux1d().

Here is the caller graph for this function:

◆ sw_pen_frac_morel()

real function mom_opacity::sw_pen_frac_morel ( real, intent(in) chl_data )

private

This sets the penetrating shortwave fraction according to the scheme proposed by Morel and Antoine (1994).

Parameters

[in] chl_data The chlorophyll-A concentration in mg m-3.

Returns: The returned penetrating shortwave fraction [nondim]

Definition at line 417 of file MOM_opacity.F90.

   real, intent(in)  :: chl_data !< The chlorophyll-A concentration in mg m-3.
   real :: SW_pen_frac_morel     !< The returned penetrating shortwave fraction [nondim]
  
   !   The following are coefficients for the optical model taken from Morel and
   ! Antoine (1994). These coeficients represent a non uniform distribution of
   ! chlorophyll-a through the water column.  Other approaches may be more
   ! appropriate when using an interactive ecosystem model that predicts
   ! three-dimensional chl-a values.
   real :: Chl, Chl2         ! The log10 of chl_data in mg m-3, and Chl^2.
   real, dimension(6), parameter :: &
        V1_coef=(/0.321,  0.008, 0.132,  0.038, -0.017, -0.007/)
  
   chl = log10(min(max(chl_data,0.02),60.0)) ; chl2 = chl*chl
   sw_pen_frac_morel = 1.0 - ( (v1_coef(1) + v1_coef(2)*chl) + chl2 * &
        ((v1_coef(3) + chl*v1_coef(4)) + chl2*(v1_coef(5) + chl*v1_coef(6))) )

Referenced by opacity_from_chl().

Here is the caller graph for this function:

Variable Documentation

◆ double_exp

integer, parameter mom_opacity::double_exp = 4

private

Coded integers to specify the opacity scheme.

Definition at line 77 of file MOM_opacity.F90.

Referenced by opacity_init(), and set_opacity().

◆ double_exp_string

character*(10), parameter mom_opacity::double_exp_string = "DOUBLE_EXP"

private

String to specify the opacity scheme.

Definition at line 83 of file MOM_opacity.F90.

83 character*(10), parameter :: DOUBLE_EXP_STRING = "DOUBLE_EXP" !< String to specify the opacity scheme

Referenced by opacity_init().

◆ manizza_05

integer, parameter mom_opacity::manizza_05 = 1

private

Coded integers to specify the opacity scheme.

Definition at line 77 of file MOM_opacity.F90.

Referenced by opacity_from_chl(), opacity_init(), and set_opacity().

◆ manizza_05_string

character*(10), parameter mom_opacity::manizza_05_string = "MANIZZA_05"

private

String to specify the opacity scheme.

Definition at line 80 of file MOM_opacity.F90.

80 character*(10), parameter :: MANIZZA_05_STRING = "MANIZZA_05" !< String to specify the opacity scheme

Referenced by opacity_init().

◆ morel_88

integer, parameter mom_opacity::morel_88 = 2

private

Coded integers to specify the opacity scheme.

Definition at line 77 of file MOM_opacity.F90.

Referenced by opacity_from_chl(), and opacity_init().

◆ morel_88_string

character*(10), parameter mom_opacity::morel_88_string = "MOREL_88"

private

String to specify the opacity scheme.

Definition at line 81 of file MOM_opacity.F90.

81 character*(10), parameter :: MOREL_88_STRING = "MOREL_88" !< String to specify the opacity scheme

Referenced by opacity_init().

◆ no_scheme

integer, parameter mom_opacity::no_scheme = 0

Coded integers to specify the opacity scheme.

Definition at line 77 of file MOM_opacity.F90.

77 integer, parameter :: NO_SCHEME = 0, manizza_05 = 1, morel_88 = 2, single_exp = 3, double_exp = 4

Referenced by opacity_init().

◆ op_diag_len

real, parameter mom_opacity::op_diag_len = 1e-10

private

Lengthscale L used to remap opacity from op to 1/L * tanh(op * L)

Definition at line 85 of file MOM_opacity.F90.

85 real, parameter :: op_diag_len = 1e-10 !< Lengthscale L used to remap opacity

Referenced by set_opacity().

◆ single_exp

integer, parameter mom_opacity::single_exp = 3

private

Coded integers to specify the opacity scheme.

Definition at line 77 of file MOM_opacity.F90.

Referenced by opacity_init().

◆ single_exp_string

character*(10), parameter mom_opacity::single_exp_string = "SINGLE_EXP"

private

String to specify the opacity scheme.

Definition at line 82 of file MOM_opacity.F90.

82 character*(10), parameter :: SINGLE_EXP_STRING = "SINGLE_EXP" !< String to specify the opacity scheme

Referenced by opacity_init().

Detailed Description

Data Types

Function/Subroutine Documentation

◆ absorbremainingsw()

◆ extract_optics_fields()

◆ extract_optics_slice()

◆ opacity_end()

◆ opacity_from_chl()

◆ opacity_init()

◆ opacity_manizza()

◆ opacity_morel()

◆ optics_nbands()

◆ set_opacity()

◆ sumswoverbands()

◆ sw_pen_frac_morel()

Variable Documentation

◆ double_exp

◆ double_exp_string

◆ manizza_05

◆ manizza_05_string

◆ morel_88

◆ morel_88_string

◆ no_scheme

◆ op_diag_len

◆ single_exp

◆ single_exp_string