Skip to content

Commit

Permalink
Deprecate zsalinity (#448)
Browse files Browse the repository at this point in the history 
* Deprecate zsalinity mostly with ifdef and comments for testing

* Deprecate zsalinity, remove code

* Update zsalinity warning messages

Update interface documentation
  • Loading branch information
@apcraig
apcraig authored Aug 22, 2023
1 parent 86cae16 commit f5e093f
Show file tree
Hide file tree
Showing 34 changed files with 139 additions and 2,103 deletions.
261 changes: 6 additions & 255 deletions columnphysics/icepack_brine.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ module icepack_brine
use icepack_parameters, only: gravit, rhoi, rhow, rhos, depressT
use icepack_parameters, only: salt_loss, min_salin, rhosi
use icepack_parameters, only: dts_b, l_sk
use icepack_tracers, only: ntrcr, nt_qice, nt_sice, nt_bgc_S
use icepack_tracers, only: ntrcr, nt_qice, nt_sice
use icepack_tracers, only: nt_Tsfc
use icepack_zbgc_shared, only: k_o, exp_h, Dm, Ra_c, viscos_dynamic, thinS
use icepack_zbgc_shared, only: remap_zbgc
Expand All @@ -27,10 +27,9 @@ module icepack_brine
public :: preflushing_changes, &
compute_microS_mushy, &
update_hbrine, &
compute_microS, &
calculate_drho, &
icepack_init_hbrine, &
icepack_init_zsalinity
icepack_init_zsalinity ! deprecated

real (kind=dbl_kind), parameter :: &
maxhbr = 1.25_dbl_kind , & ! brine overflows if hbr > maxhbr*hin
Expand Down Expand Up @@ -131,7 +130,6 @@ subroutine preflushing_changes (aicen, vicen, vsnon, &
end subroutine preflushing_changes

!=======================================================================

! Computes ice microstructural properties for updating hbrine
!
! NOTE: This subroutine uses thermosaline_vertical output to compute
Expand Down Expand Up @@ -558,239 +556,6 @@ subroutine update_hbrine (meltt, &

end subroutine update_hbrine

!=======================================================================
!
! Computes ice microstructural properties for zbgc and zsalinity
!
! NOTE: In this subroutine, trcrn(nt_fbri) is the volume fraction of ice with
! dynamic salinity or the height ratio == hbr/vicen*aicen, where hbr is the
! height of the brine surface relative to the bottom of the ice.
! This volume fraction
! may be > 1 in which case there is brine above the ice surface (meltponds).
!
subroutine compute_microS (n_cat, nilyr, nblyr, &
bgrid, cgrid, igrid, &
trcrn, hice_old, &
hbr_old, sss, sst, &
bTin, iTin, bphin, &
kperm, bphi_min, &
Rayleigh_criteria, firstice, &
bSin, brine_sal, &
brine_rho, iphin, ibrine_rho, &
ibrine_sal, sice_rho, sloss)

integer (kind=int_kind), intent(in) :: &
n_cat , & ! ice category
nilyr , & ! number of ice layers
nblyr ! number of bio layers

real (kind=dbl_kind), dimension (nblyr+2), intent(in) :: &
bgrid ! biology nondimensional vertical grid points

real (kind=dbl_kind), dimension (nblyr+1), intent(in) :: &
igrid ! biology vertical interface points

real (kind=dbl_kind), dimension (nilyr+1), intent(in) :: &
cgrid ! CICE vertical coordinate

real (kind=dbl_kind), intent(in) :: &
hice_old , & ! previous timestep ice height (m)
sss , & ! ocean salinity (ppt)
sst ! ocean temperature (oC)

real (kind=dbl_kind), dimension(ntrcr), intent(inout) :: &
trcrn

real (kind=dbl_kind), intent(inout) :: &
hbr_old , & ! old brine height
sice_rho ! average ice density

real (kind=dbl_kind), dimension (nblyr+2), intent(inout) :: &
bTin , & ! Temperature of ice layers on bio grid for history file (^oC)
bphin , & ! Porosity of layers
brine_sal , & ! equilibrium brine salinity (ppt)
brine_rho ! Internal brine density (kg/m^3)

real (kind=dbl_kind), dimension (nblyr+2), intent(out) :: &
bSin

real (kind=dbl_kind), dimension (nblyr+1), intent(out) :: &
iTin ! Temperature on the interface grid

real (kind=dbl_kind), intent(out) :: &
bphi_min , & ! surface porosity
kperm , & ! average ice permeability (m^2)
sloss ! (g/m^2) salt from brine runoff for hbr > maxhbr*hin

logical (kind=log_kind), intent(inout) :: &
Rayleigh_criteria ! .true. if ice exceeded a minimum thickness hin >= Ra_c

logical (kind=log_kind), intent(in) :: &
firstice ! .true. if ice is newly formed

real (kind=dbl_kind), dimension (nblyr+1), intent(inout) :: &
iphin , & ! porosity on the igrid
ibrine_rho , & ! brine rho on interface
ibrine_sal ! brine sal on interface

! local variables

integer (kind=int_kind) :: &
k ! vertical biology layer index

real (kind=dbl_kind) :: &
surface_S , & ! salinity of ice above hin > hbr
hinc_old ! ice thickness (cell quantity) before current melt/growth (m)

! logical (kind=log_kind) :: &
! Rayleigh ! .true. if ice exceeded a minimum thickness hin >= Ra_c

real (kind=dbl_kind), dimension (ntrcr+2) :: &
trtmp0 , & ! temporary, remapped tracers
trtmp ! temporary, remapped tracers

real (kind=dbl_kind) :: &
Tmlts ! melting temperature

character(len=*),parameter :: subname='(compute_microS)'

!-----------------------------------------------------------------
! Initialize
!-----------------------------------------------------------------

sloss = c0
bTin(:) = c0
bSin(:) = c0

trtmp(:) = c0
surface_S = min_salin

hinc_old = hice_old

!-----------------------------------------------------------------
! Rayleigh condition for salinity and bgc:
! Implemented as a minimum thickness criteria for category 1 ice only.
! When hin >= Ra_c (m), pressure flow is allowed.
! Turn off by putting Ra_c = 0 in ice_in namelist.
!-----------------------------------------------------------------

! Rayleigh = .true.
! if (n_cat == 1 .AND. hbr_old < Ra_c) then
! Rayleigh = Rayleigh_criteria ! only category 1 ice can be false
! endif

!-----------------------------------------------------------------
! Define ice salinity on Sin
!-----------------------------------------------------------------

if (firstice) then

do k = 1, nilyr
trcrn(nt_sice+k-1) = sss*salt_loss
enddo

call remap_zbgc(nilyr, &
nt_sice, &
trcrn, trtmp, &
0, nblyr, &
hinc_old, hinc_old, &
cgrid(2:nilyr+1), &
bgrid(2:nblyr+1), surface_S )
if (icepack_warnings_aborted(subname)) return

do k = 1, nblyr
trcrn(nt_bgc_S+k-1) = max(min_salin,trtmp(nt_sice+k-1))
bSin(k+1) = max(min_salin,trcrn(nt_bgc_S+k-1))
if (trcrn(nt_bgc_S+k-1) < min_salin-puny) &
call icepack_warnings_setabort(.true.,__FILE__,__LINE__)
enddo ! k

bSin(1) = bSin(2)
bSin(nblyr+2) = sss

elseif (hbr_old > maxhbr*hice_old) then

call remap_zbgc(nblyr, &
nt_bgc_S, &
trcrn, trtmp, &
0, nblyr, &
hbr_old, &
maxhbr*hinc_old, &
bgrid(2:nblyr+1), &
bgrid(2:nblyr+1), surface_S )
if (icepack_warnings_aborted(subname)) return

do k = 1, nblyr
bSin(k+1) = max(min_salin,trtmp(nt_bgc_S+k-1))
sloss = sloss + rhosi*(hbr_old*trcrn(nt_bgc_S+k-1) &
- maxhbr*hice_old*bSin(k+1))*(igrid(k+1)-igrid(k))
trcrn(nt_bgc_S+k-1) = bSin(k+1)
if (trcrn(nt_bgc_S+k-1) < min_salin-puny) &
call icepack_warnings_setabort(.true.,__FILE__,__LINE__)
enddo ! k

bSin(1) = bSin(2)
bSin(nblyr+2) = sss
hbr_old = maxhbr*hinc_old

else ! old, thin ice

do k = 1, nblyr
trcrn(nt_bgc_S+k-1) = max(min_salin,trcrn(nt_bgc_S+k-1))
bSin (k+1) = trcrn(nt_bgc_S+k-1)
enddo ! k

bSin (1) = bSin(2)
bSin (nblyr+2) = sss

endif ! ice type

!-----------------------------------------------------------------
! sea ice temperature for bio grid
!-----------------------------------------------------------------

do k = 1, nilyr
Tmlts = -trcrn(nt_sice+k-1)*depressT
trtmp0(nt_qice+k-1) = calculate_Tin_from_qin(trcrn(nt_qice+k-1),Tmlts)
enddo ! k

trtmp(:) = c0

! CICE to Bio: remap temperatures
call remap_zbgc (nilyr, nt_qice, &
trtmp0(1:ntrcr), trtmp, &
0, nblyr, &
hinc_old, hbr_old, &
cgrid(2:nilyr+1), &
bgrid(2:nblyr+1), surface_S )
if (icepack_warnings_aborted(subname)) return

do k = 1, nblyr
Tmlts = -bSin(k+1) * depressT
bTin (k+1) = min(Tmlts,trtmp(nt_qice+k-1))
enddo !k

Tmlts = -min_salin* depressT
bTin (1) = min(Tmlts,(bTin(2) + trcrn(nt_Tsfc))*p5)
Tmlts = -bSin(nblyr+2)* depressT
bTin (nblyr+2) = sst

!-----------------------------------------------------------------
! Define ice multiphase structure
!-----------------------------------------------------------------

call prepare_hbrine (nblyr, &
bSin, bTin, iTin, &
brine_sal, brine_rho, &
ibrine_sal, ibrine_rho, &
sice_rho, &
bphin, iphin, &
kperm, bphi_min, &
igrid, sss)
if (icepack_warnings_aborted(subname)) return

end subroutine compute_microS

!==========================================================================================
!
! Find density difference about interface grid points
Expand Down Expand Up @@ -1000,7 +765,8 @@ end subroutine icepack_init_hbrine

!=======================================================================
!autodocument_start icepack_init_zsalinity
! Initialize zSalinity
! **DEPRECATED**, all code removed
! Interface provided for backwards compatibility

subroutine icepack_init_zsalinity(nblyr,ntrcr_o, Rayleigh_criteria, &
Rayleigh_real, trcrn_bgc, nt_bgc_S, ncat, sss)
Expand All @@ -1027,27 +793,12 @@ subroutine icepack_init_zsalinity(nblyr,ntrcr_o, Rayleigh_criteria, &

! local variables

integer (kind=int_kind) :: &
k, n

character(len=*),parameter :: subname='(icepack_init_zsalinity)'

if (nblyr .LE. 7) then
dts_b = 300.0_dbl_kind
else
dts_b = 50.0_dbl_kind
endif

Rayleigh_criteria = .false. ! no ice initial condition
Rayleigh_real = c0
do n = 1,ncat
do k = 1,nblyr
trcrn_bgc(nt_bgc_S+k-1-ntrcr_o,n) = sss*salt_loss
enddo ! k
enddo ! n
call icepack_warnings_add(subname//' DEPRECATED, do not use')
! call icepack_warnings_setabort(.true.,__FILE__,__LINE__)

end subroutine icepack_init_zsalinity

!=======================================================================

end module icepack_brine
Expand Down
2 changes: 1 addition & 1 deletion columnphysics/icepack_intfc.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ module icepack_intfc
use icepack_shortwave, only: icepack_step_radiation

use icepack_brine, only: icepack_init_hbrine
use icepack_brine, only: icepack_init_zsalinity
use icepack_brine, only: icepack_init_zsalinity ! deprecated

use icepack_zbgc , only: icepack_init_bgc
use icepack_zbgc , only: icepack_init_zbgc
Expand Down
Loading

0 comments on commit f5e093f

Please sign in to comment.