Skip to content

Commit

Permalink
+Changed interface to ice_cat_transport
Browse files Browse the repository at this point in the history 
  Changed uc and vc into optional arguments to ice_cat_transport and added
optional net transport and net mass arguments to ice_cat_transport, allowing
this routine to either calculate the fluxes internally or take specified
fluxes as arguments.  All answers are bitwise identical.
  • Loading branch information
@Hallberg-NOAA
Hallberg-NOAA committed Dec 5, 2018
1 parent 4f06216 commit a04688c
Showing 1 changed file with 49 additions and 28 deletions.
77 changes: 49 additions & 28 deletions src/SIS_transport.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,17 @@ subroutine ice_transport(IST, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS, snow2oc

! Local variables
type(cell_average_state_type), pointer :: CAS => NULL()
real, dimension(SZI_(G),SZJ_(G),max(nsteps+1,1)) :: &
mca_tot ! The total mass per unit total area of snow and ice summed across thickness
! categories in a cell, before each substep, in units of H (often kg m-2).
real, dimension(SZIB_(G),SZJ_(G),max(nsteps,1)) :: &
uh_tot ! Total zonal fluxes during each substep in H m2 s-1.
real, dimension(SZI_(G),SZJB_(G),max(nsteps,1)) :: &
vh_tot ! Total meridional fluxes during each substep in H m2 s-1.
real :: dt_adv
integer :: i, j, k, n, isc, iec, jsc, jec, nCat

isc = G%isc ; iec = G%iec ; jsc = G%jsc ; jec = G%jec ; nCat = IG%CatIce

call pass_vector(uc, vc, G%Domain, stagger=CGRID_NE)

Expand All @@ -140,26 +151,53 @@ subroutine ice_transport(IST, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS, snow2oc
! Determine the whole-cell averaged mass of snow and ice.
call ice_state_to_cell_ave_state(IST, G, IG, CS, CAS)

call ice_cat_transport(CAS, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS)
if (CS%merged_cont) then
! mca_tot, uh_tot, and vh_tot will become input variables.
if (nsteps > 0) dt_adv = dt_slow / real(nsteps)
mca_tot(:,:,:) = 0.0
do j=jsc,jec ; do i=isc,iec ; mca_tot(i,j,1) = 0.0 ; enddo ; enddo
do k=1,nCat ; do j=jsc,jec ; do i=isc,iec
mca_tot(i,j,1) = mca_tot(i,j,1) + (CAS%m_ice(i,j,k) + (CAS%m_snow(i,j,k) + CAS%m_pond(i,j,k)))
enddo ; enddo ; enddo
call pass_var(mca_tot(:,:,1), G%Domain)

do n = 1, nsteps
call summed_continuity(uc, vc, mca_tot(:,:,n), mca_tot(:,:,n+1), uh_tot(:,:,n), vh_tot(:,:,n), &
dt_adv, G, IG, CS%continuity_CSp)
call pass_var(mca_tot(:,:,n), G%Domain)
enddo

call ice_cat_transport(CAS, TrReg, dt_slow, nsteps, G, IG, CS, mca_tot=mca_tot, uh_tot=uh_tot, vh_tot=vh_tot)
else
call ice_cat_transport(CAS, TrReg, dt_slow, nsteps, G, IG, CS, uc=uc, vc=vc)
endif


call finish_ice_transport(CAS, IST, TrReg, G, IG, CS, snow2ocn, rdg_rate)

end subroutine ice_transport

!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~!
!> ice_cat_transport does ice transport of mass and tracers by thickness category
subroutine ice_cat_transport(CAS, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS)
subroutine ice_cat_transport(CAS, TrReg, dt_slow, nsteps, G, IG, CS, uc, vc, mca_tot, uh_tot, vh_tot)
type(cell_average_state_type), intent(inout) :: CAS !< A structure with ocean-cell averaged masses.
type(SIS_hor_grid_type), intent(inout) :: G !< The horizontal grid type
type(ice_grid_type), intent(inout) :: IG !< The sea-ice specific grid type
type(SIS_tracer_registry_type), pointer :: TrReg !< The registry of SIS ice and snow tracers.
real, dimension(SZIB_(G),SZJ_(G)), intent(inout) :: uc !< The zonal ice velocity, in m s-1.
real, dimension(SZI_(G),SZJB_(G)), intent(inout) :: vc !< The meridional ice velocity, in m s-1.
real, intent(in) :: dt_slow !< The amount of time over which the
!! ice dynamics are to be advanced, in s.
integer, intent(in) :: nsteps !< The number of advective iterations
!! to use within this time step.
type(SIS_transport_CS), pointer :: CS !< A pointer to the control structure for this module
real, dimension(SZIB_(G),SZJ_(G)), optional, intent(in) :: uc !< The zonal ice velocity, in m s-1.
real, dimension(SZI_(G),SZJB_(G)), optional, intent(in) :: vc !< The meridional ice velocity, in m s-1.
real, dimension(SZI_(G),SZJ_(G),max(nsteps+1,1)), optional, intent(in) :: &
mca_tot ! The total mass per unit total area of snow and ice summed across thickness
! categories in a cell, before each substep, in units of H (often kg m-2).
real, dimension(SZIB_(G),SZJ_(G),max(nsteps,1)), optional, intent(in) :: &
uh_tot ! Total zonal fluxes during each substep in H m2 s-1.
real, dimension(SZI_(G),SZJB_(G),max(nsteps,1)), optional, intent(in) :: &
vh_tot ! Total meridional fluxes during each substep in H m2 s-1.

! Local variables
real, dimension(SZIB_(G),SZJ_(G),SZCAT_(IG)) :: &
Expand All @@ -175,14 +213,8 @@ subroutine ice_cat_transport(CAS, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS)
mca0_snow, & ! The initial mass of snow per unit ocean area in a cell, in H (often kg m-2).
mca0_pond ! The initial mass of melt pond water per unit ocean area
! in a cell, in H (often kg m-2).
real, dimension(SZI_(G),SZJ_(G),max(nsteps+1,1)) :: &
mca_tot ! The total mass per unit total area of snow and ice summed across thickness
! categories in a cell, in units of H (often kg m-2).
real, dimension(SZIB_(G),SZJ_(G),max(nsteps,1)) :: &
uh_tot ! Total zonal fluxes in H m2 s-1.
real, dimension(SZI_(G),SZJB_(G),max(nsteps,1)) :: &
vh_tot ! Total meridional fluxes in H m2 s-1.
real :: dt_adv
logical :: merged_cont
character(len=200) :: mesg
integer :: i, j, k, n, isc, iec, jsc, jec, isd, ied, jsd, jed, nCat

Expand All @@ -196,22 +228,11 @@ subroutine ice_cat_transport(CAS, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS)
if (CS%bounds_check) call check_SIS_tracer_bounds(TrReg, G, IG, "SIS_transport set massless 1")
endif

if (CS%merged_cont) then
! mca_tot, uh_tot, and vh_tot will become input variables.
if (nsteps > 0) dt_adv = dt_slow / real(nsteps)
mca_tot(:,:,:) = 0.0
do j=jsc,jec ; do i=isc,iec ; mca_tot(i,j,1) = 0.0 ; enddo ; enddo
do k=1,nCat ; do j=jsc,jec ; do i=isc,iec
mca_tot(i,j,1) = mca_tot(i,j,1) + (CAS%m_ice(i,j,k) + (CAS%m_snow(i,j,k) + CAS%m_pond(i,j,k)))
enddo ; enddo ; enddo
call pass_var(mca_tot(:,:,1), G%Domain)

do n = 1, nsteps
call summed_continuity(uc, vc, mca_tot(:,:,n), mca_tot(:,:,n+1), uh_tot(:,:,n), vh_tot(:,:,n), &
dt_adv, G, IG, CS%continuity_CSp)
call pass_var(mca_tot(:,:,n), G%Domain)
enddo
endif
merged_cont = (present(mca_tot) .and. present(uh_tot) .and. present(vh_tot))
if (merged_cont .and. (present(uc) .or. present(vc))) call SIS_error(WARNING, &
"Velocities should not be provided to ice_cat_transport when mass fluxes are provided.")
if ((.not. merged_cont) .and. .not.(present(uc) .and. present(vc))) call SIS_error(FATAL, &
"Either velocities or masses and mass fluxes must appear in a call to ice_cat_transport.")

! Do the transport via the continuity equations and tracer conservation equations
! for CAS%mH_ice and tracers, inverting for the fractional size of each partition.
Expand All @@ -229,7 +250,7 @@ subroutine ice_cat_transport(CAS, uc, vc, TrReg, dt_slow, nsteps, G, IG, CS)
mca0_pond(i,j,k) = CAS%m_pond(i,j,k)
enddo ; enddo ; enddo

if (CS%merged_cont) then
if (merged_cont) then
call proportionate_continuity(mca_tot(:,:,n), uh_tot(:,:,n), vh_tot(:,:,n), &
dt_adv, G, IG, CS%continuity_CSp, &
h1=CAS%m_ice, uh1=uh_ice, vh1=vh_ice, &
Expand Down

0 comments on commit a04688c

Please sign in to comment.