Detailed Description

Routines incorporating the effects of marine ice (sea-ice and icebergs) into the ocean model dynamics and thermodynamics.

Data Types
type	marine_ice_cs
	Control structure for MOM_marine_ice. More...

Functions/Subroutines
subroutine, public	iceberg_forces (G, forces, use_ice_shelf, sfc_state, time_step, CS)
	add_berg_flux_to_shelf adds rigidity and ice-area coverage due to icebergs to the forces type fields, and adds ice-areal coverage and modifies various thermodynamic fluxes due to the presence of icebergs. More...

subroutine, public	iceberg_fluxes (G, US, fluxes, use_ice_shelf, sfc_state, time_step, CS)
	iceberg_fluxes adds ice-area-coverage and modifies various thermodynamic fluxes due to the presence of icebergs. More...

subroutine, public	marine_ice_init (Time, G, param_file, diag, CS)
	Initialize control structure for MOM_marine_ice. More...

Function/Subroutine Documentation

◆ iceberg_fluxes()

subroutine, public mom_marine_ice::iceberg_fluxes	(	type(ocean_grid_type), intent(inout)	G,
		type(unit_scale_type), intent(in)	US,
		type(forcing), intent(inout)	fluxes,
		logical, intent(in)	use_ice_shelf,
		type(surface), intent(inout)	sfc_state,
		real, intent(in)	time_step,
		type(marine_ice_cs), pointer	CS
	)

iceberg_fluxes adds ice-area-coverage and modifies various thermodynamic fluxes due to the presence of icebergs.

Parameters

[in,out]	g	The ocean's grid structure
[in]	us	A dimensional unit scaling type
[in,out]	fluxes	A structure with pointers to themodynamic, tracer and mass exchange forcing fields
[in,out]	sfc_state	A structure containing fields that describe the surface state of the ocean.
[in]	use_ice_shelf	If true, this configuration uses ice shelves.
[in]	time_step	The coupling time step [s].
	cs	Pointer to the control structure for MOM_marine_ice

Definition at line 108 of file MOM_marine_ice.F90.

   type(ocean_grid_type), intent(inout) :: G       !< The ocean's grid structure
   type(unit_scale_type), intent(in)    :: US      !< A dimensional unit scaling type
   type(forcing),         intent(inout) :: fluxes  !< A structure with pointers to themodynamic,
                                                   !! tracer and mass exchange forcing fields
   type(surface),         intent(inout) :: sfc_state !< A structure containing fields that
                                                     !! describe the surface state of the ocean.
   logical,               intent(in)    :: use_ice_shelf  !< If true, this configuration uses ice shelves.
   real,                  intent(in)    :: time_step   !< The coupling time step [s].
   type(marine_ice_CS),   pointer       :: CS !< Pointer to the control structure for MOM_marine_ice
  
   real :: fraz      ! refreezing rate [R Z T-1 ~> kg m-2 s-1]
   real :: I_dt_LHF  ! The inverse of the timestep times the latent heat of fusion [kg J-1 T-1 ~> kg J-1 s-1].
   integer :: i, j, is, ie, js, je, isd, ied, jsd, jed
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec
   isd = g%isd ; jsd = g%jsd ; ied = g%ied ; jed = g%jed
   !This routine adds iceberg data to the ice shelf data (if ice shelf is used)
   !which can then be used to change the top of ocean boundary condition used in
   !the ocean model. This routine is taken from the add_shelf_flux subroutine
   !within the ice shelf model.
  
   if (.not.associated(cs)) return
   if (.not.(associated(fluxes%area_berg) .and. associated(fluxes%ustar_berg) .and. &
             associated(fluxes%mass_berg) ) ) return
   if (.not.(associated(fluxes%frac_shelf_h) .and. associated(fluxes%ustar_shelf)) ) return
  
  
   if (.not.(associated(fluxes%area_berg) .and. associated(fluxes%ustar_berg) .and. &
             associated(fluxes%mass_berg) ) ) return
   if (.not. use_ice_shelf) then
     fluxes%frac_shelf_h(:,:) = 0.
     fluxes%ustar_shelf(:,:) = 0.
   endif
   do j=jsd,jed ; do i=isd,ied ; if (g%areaT(i,j) > 0.0) then
     fluxes%frac_shelf_h(i,j) = fluxes%frac_shelf_h(i,j) + fluxes%area_berg(i,j)
     fluxes%ustar_shelf(i,j)  = fluxes%ustar_shelf(i,j)  + fluxes%ustar_berg(i,j)
   endif ; enddo ; enddo
  
   !Zero'ing out other fluxes under the tabular icebergs
   if (cs%berg_area_threshold >= 0.) then
     i_dt_lhf = 1.0 / (us%s_to_T*time_step * cs%latent_heat_fusion)
     do j=jsd,jed ; do i=isd,ied
       if (fluxes%frac_shelf_h(i,j) > cs%berg_area_threshold) then
         ! Only applying for ice shelf covering most of cell.
  
         if (associated(fluxes%sw)) fluxes%sw(i,j) = 0.0
         if (associated(fluxes%lw)) fluxes%lw(i,j) = 0.0
         if (associated(fluxes%latent)) fluxes%latent(i,j) = 0.0
         if (associated(fluxes%evap)) fluxes%evap(i,j) = 0.0
  
         ! Add frazil formation diagnosed by the ocean model [J m-2] in the
         ! form of surface layer evaporation [R Z T-1 ~> kg m-2 s-1]. Update lprec in the
         ! control structure for diagnostic purposes.
  
         if (associated(sfc_state%frazil)) then
           fraz = us%kg_m3_to_R*us%m_to_Z*sfc_state%frazil(i,j) * i_dt_lhf
           if (associated(fluxes%evap)) &
             fluxes%evap(i,j) = fluxes%evap(i,j) - fraz
           ! fluxes%lprec(i,j) = fluxes%lprec(i,j) - fraz
           sfc_state%frazil(i,j) = 0.0
         endif
  
         !Alon: Should these be set to zero too?
         if (associated(fluxes%sens)) fluxes%sens(i,j) = 0.0
         if (associated(fluxes%salt_flux)) fluxes%salt_flux(i,j) = 0.0
         if (associated(fluxes%lprec)) fluxes%lprec(i,j) = 0.0
       endif
     enddo ; enddo
   endif
  

Referenced by mom_ocean_model_mct::update_ocean_model(), and mom_ocean_model_nuopc::update_ocean_model().

Here is the caller graph for this function:

◆ iceberg_forces()

subroutine, public mom_marine_ice::iceberg_forces	(	type(ocean_grid_type), intent(inout)	G,
		type(mech_forcing), intent(inout)	forces,
		logical, intent(in)	use_ice_shelf,
		type(surface), intent(inout)	sfc_state,
		real, intent(in)	time_step,
		type(marine_ice_cs), pointer	CS
	)

add_berg_flux_to_shelf adds rigidity and ice-area coverage due to icebergs to the forces type fields, and adds ice-areal coverage and modifies various thermodynamic fluxes due to the presence of icebergs.

Parameters

[in,out]	g	The ocean's grid structure
[in,out]	forces	A structure with the driving mechanical forces
[in,out]	sfc_state	A structure containing fields that describe the surface state of the ocean.
[in]	use_ice_shelf	If true, this configuration uses ice shelves.
[in]	time_step	The coupling time step [s].
	cs	Pointer to the control structure for MOM_marine_ice

Definition at line 47 of file MOM_marine_ice.F90.

   type(ocean_grid_type), intent(inout) :: G       !< The ocean's grid structure
   type(mech_forcing),    intent(inout) :: forces  !< A structure with the driving mechanical forces
   type(surface),         intent(inout) :: sfc_state !< A structure containing fields that
                                                     !! describe the surface state of the ocean.
   logical,               intent(in)    :: use_ice_shelf  !< If true, this configuration uses ice shelves.
   real,                  intent(in)    :: time_step   !< The coupling time step [s].
   type(marine_ice_CS),   pointer       :: CS !< Pointer to the control structure for MOM_marine_ice
  
   real :: kv_rho_ice ! The viscosity of ice divided by its density [m5 kg-1 s-1].
   integer :: i, j, is, ie, js, je
   is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec
   !This routine adds iceberg data to the ice shelf data (if ice shelf is used)
   !which can then be used to change the top of ocean boundary condition used in
   !the ocean model. This routine is taken from the add_shelf_flux subroutine
   !within the ice shelf model.
  
   if (.not.associated(cs)) return
  
   if (.not.(associated(forces%area_berg) .and.  associated(forces%mass_berg) ) ) return
  
   if (.not.(associated(forces%frac_shelf_u) .and. associated(forces%frac_shelf_v) .and. &
             associated(forces%rigidity_ice_u) .and. associated(forces%rigidity_ice_v)) ) return
  
   ! This section sets or augments the values of fields in forces.
   if (.not. use_ice_shelf) then
     forces%frac_shelf_u(:,:) = 0.0 ; forces%frac_shelf_v(:,:) = 0.0
   endif
   if (.not. forces%accumulate_rigidity) then
     forces%rigidity_ice_u(:,:) = 0.0 ; forces%rigidity_ice_v(:,:) = 0.0
   endif
  
   call pass_var(forces%area_berg, g%domain, to_all+omit_corners, halo=1, complete=.false.)
   call pass_var(forces%mass_berg, g%domain, to_all+omit_corners, halo=1, complete=.true.)
   kv_rho_ice = cs%kv_iceberg / cs%density_iceberg
   do j=js,je ; do i=is-1,ie
     if ((g%areaT(i,j) + g%areaT(i+1,j) > 0.0)) & ! .and. (G%dxdy_u(I,j) > 0.0)) &
       forces%frac_shelf_u(i,j) = forces%frac_shelf_u(i,j) + &
           (((forces%area_berg(i,j)*g%US%L_to_m**2*g%areaT(i,j)) + &
             (forces%area_berg(i+1,j)*g%US%L_to_m**2*g%areaT(i+1,j))) / &
            (g%US%L_to_m**2*g%areaT(i,j) + g%US%L_to_m**2*g%areaT(i+1,j)) )
     forces%rigidity_ice_u(i,j) = forces%rigidity_ice_u(i,j) + kv_rho_ice * &
                          min(forces%mass_berg(i,j), forces%mass_berg(i+1,j))
   enddo ; enddo
   do j=js-1,je ; do i=is,ie
     if ((g%areaT(i,j) + g%areaT(i,j+1) > 0.0)) & ! .and. (G%dxdy_v(i,J) > 0.0)) &
       forces%frac_shelf_v(i,j) = forces%frac_shelf_v(i,j) + &
           (((forces%area_berg(i,j)*g%US%L_to_m**2*g%areaT(i,j)) + &
             (forces%area_berg(i,j+1)*g%US%L_to_m**2*g%areaT(i,j+1))) / &
            (g%US%L_to_m**2*g%areaT(i,j) + g%US%L_to_m**2*g%areaT(i,j+1)) )
     forces%rigidity_ice_v(i,j) = forces%rigidity_ice_v(i,j) + kv_rho_ice * &
                          min(forces%mass_berg(i,j), forces%mass_berg(i,j+1))
   enddo ; enddo
   !### This halo update may be unnecessary. Test it.  -RWH
   call pass_vector(forces%frac_shelf_u, forces%frac_shelf_v, g%domain, to_all, cgrid_ne)
  

References mom_domains::to_all.

Referenced by mom_ocean_model_mct::update_ocean_model(), and mom_ocean_model_nuopc::update_ocean_model().

Here is the caller graph for this function:

◆ marine_ice_init()

subroutine, public mom_marine_ice::marine_ice_init	(	type(time_type), intent(in), target	Time,
		type(ocean_grid_type), intent(in)	G,
		type(param_file_type), intent(in)	param_file,
		type(diag_ctrl), intent(inout), target	diag,
		type(marine_ice_cs), pointer	CS
	)

Initialize control structure for MOM_marine_ice.

Parameters

[in]	time	Current model time
[in]	g	Ocean grid structure
[in]	param_file	Runtime parameter handles
[in,out]	diag	Diagnostics control structure
	cs	Pointer to the control structure for MOM_marine_ice

Definition at line 181 of file MOM_marine_ice.F90.

   type(time_type), target, intent(in)    :: Time !< Current model time
   type(ocean_grid_type),   intent(in)    :: G !< Ocean grid structure
   type(param_file_type),   intent(in)    :: param_file !< Runtime parameter handles
   type(diag_ctrl), target, intent(inout) :: diag !< Diagnostics control structure
   type(marine_ice_CS),     pointer       :: CS   !< Pointer to the control structure for MOM_marine_ice
 ! This include declares and sets the variable "version".
 #include "version_variable.h"
   character(len=40)  :: mdl = "MOM_marine_ice"  ! This module's name.
  
   if (associated(cs)) then
     call mom_error(warning, "marine_ice_init called with an associated control structure.")
     return
   else ; allocate(cs) ; endif
  
   ! Write all relevant parameters to the model log.
   call log_version(mdl, version)
  
   call get_param(param_file, mdl, "KV_ICEBERG",  cs%kv_iceberg, &
                  "The viscosity of the icebergs",  units="m2 s-1",default=1.0e10)
   call get_param(param_file, mdl, "DENSITY_ICEBERGS",  cs%density_iceberg, &
                  "A typical density of icebergs.", units="kg m-3", default=917.0)
   call get_param(param_file, mdl, "LATENT_HEAT_FUSION", cs%latent_heat_fusion, &
                  "The latent heat of fusion.", units="J/kg", default=hlf)
   call get_param(param_file, mdl, "BERG_AREA_THRESHOLD", cs%berg_area_threshold, &
                  "Fraction of grid cell which iceberg must occupy, so that fluxes "//&
                  "below berg are set to zero. Not applied for negative "//&
                  "values.", units="non-dim", default=-1.0)
  

References mom_error_handler::mom_error().

Referenced by mom_ocean_model_mct::ocean_model_init(), and mom_ocean_model_nuopc::ocean_model_init().

Here is the call graph for this function:

Here is the caller graph for this function:

Detailed Description

Data Types

Functions/Subroutines

Function/Subroutine Documentation

◆ iceberg_fluxes()

◆ iceberg_forces()

◆ marine_ice_init()