Vertical intergal diagnostics for inert tracers

Author: Mariona Claret

generic_tracers/generic_CFC.F90

@@ -124,12 +124,23 @@ module generic_CFC
 
   type generic_CFC_type
     integer :: &
-      id_fgcfc11      = -1, &
-      id_fgcfc12      = -1
+      id_fgcfc11      = -1,    &
+      id_fgcfc12      = -1,    &
+      id_wc_vert_int_cfc11 = -1, &
+      id_wc_vert_int_cfc12 = -1
+
+    real, dimension(:,:), ALLOCATABLE :: &
+      wc_vert_int_cfc11, &
+      wc_vert_int_cfc12
+
     real, dimension (:,:), pointer :: &
       stf_gas_cfc11, &
       stf_gas_cfc12
 
+    real, dimension(:,:,:,:), pointer :: &
+      p_cfc11, &
+      p_cfc12
+
   end type generic_CFC_type
 
   type(generic_CFC_type) :: cfc
@@ -144,8 +155,6 @@ subroutine generic_CFC_register(tracer_list)
     !Specify all prognostic and diagnostic tracers of this modules.
     call user_add_tracers(tracer_list)
 
-    
-    
   end subroutine generic_CFC_register
 
   ! <SUBROUTINE NAME="generic_CFC_init">
@@ -175,7 +184,7 @@ subroutine generic_CFC_init(tracer_list)
     call user_add_params
 
     !Allocate and initiate all the private work arrays used by this module.
-    !    call user_allocate_arrays !None for CFC module currently
+    call user_allocate_arrays
 
   end subroutine generic_CFC_init
 
@@ -214,14 +223,33 @@ subroutine generic_CFC_register_diag(diag_list)
          init_time, vardesc_temp%longname,vardesc_temp%units, missing_value = missing_value1, &
          standard_name="surface_downward_mole_flux_of_cfc12")
 
+    vardesc_temp = vardesc("wc_vert_int_cfc11","Total CFC11 vertical integral",'h','1','s','mol m-2','f')
+    cfc%id_wc_vert_int_cfc11 = register_diag_field(package_name, vardesc_temp%name, axes(1:2),&
+         init_time, vardesc_temp%longname,vardesc_temp%units, missing_value = missing_value1)
+
+    vardesc_temp = vardesc("wc_vert_int_cfc12","Total CFC12 vertical integral",'h','1','s','mol m-2','f')
+    cfc%id_wc_vert_int_cfc12 = register_diag_field(package_name, vardesc_temp%name, axes(1:2),&
+         init_time, vardesc_temp%longname,vardesc_temp%units, missing_value = missing_value1)
+
   end subroutine generic_CFC_register_diag
 
 
   subroutine user_allocate_arrays
-    !Allocate all the private arrays.
-    !None for CFC module currently
+    integer :: isc,iec,jsc,jec,isd,ied,jsd,jed,nk,ntau,n
+    call g_tracer_get_common(isc,iec,jsc,jec,isd,ied,jsd,jed,nk,ntau) 
+
+    allocate(cfc%wc_vert_int_cfc11(isd:ied, jsd:jed))  ; cfc%wc_vert_int_cfc11=0.0
+    allocate(cfc%wc_vert_int_cfc12(isd:ied, jsd:jed))  ; cfc%wc_vert_int_cfc12=0.0
+
   end subroutine user_allocate_arrays
 
+  subroutine user_deallocate_arrays
+
+    deallocate(cfc%wc_vert_int_cfc11)
+    deallocate(cfc%wc_vert_int_cfc12)
+
+  end subroutine user_deallocate_arrays
+
   !
   !   This is an internal sub, not a public interface.
   !   Add all the parameters to be used in this module. 
@@ -330,8 +358,6 @@ subroutine user_add_params
     !Block Ends: g_tracer_add_param
     !===========
 
-
-
   end subroutine user_add_params
 
   !
@@ -407,7 +433,6 @@ subroutine user_add_tracers(tracer_list)
          diag_field_units = 'mol m-3',                               &
          diag_field_scaling_factor = 1035.0)   ! rho = 1035.0 kg/m3, converts mol/kg to mol/m3
 
-
   end subroutine user_add_tracers
 
   ! <SUBROUTINE NAME="generic_CFC_update_from_coupler">
@@ -456,6 +481,7 @@ subroutine generic_CFC_update_from_source(tracer_list,rho_dzt,dzt,hblt_depth,&
 
     character(len=fm_string_len), parameter :: sub_name = 'generic_SF6_update_from_source'
     integer :: isc,iec, jsc,jec,isd,ied,jsd,jed,nk,ntau 
+    integer :: i, j, k
     real, dimension(:,:,:) ,pointer :: grid_tmask
     integer, dimension(:,:),pointer :: mask_coast, grid_kmt
 
@@ -467,6 +493,20 @@ subroutine generic_CFC_update_from_source(tracer_list,rho_dzt,dzt,hblt_depth,&
     call g_tracer_get_pointer(tracer_list,'cfc11','stf_gas',cfc%stf_gas_cfc11)
     call g_tracer_get_pointer(tracer_list,'cfc12','stf_gas',cfc%stf_gas_cfc12)
 
+    call g_tracer_get_pointer(tracer_list,'cfc11','field',  cfc%p_cfc11)
+    call g_tracer_get_pointer(tracer_list,'cfc12','field',  cfc%p_cfc12)
+
+    !-- calculate water column vertical integrals
+    do j = jsc, jec ; do i = isc, iec !{
+       cfc%wc_vert_int_cfc11(i,j) = 0.0
+       cfc%wc_vert_int_cfc12(i,j) = 0.0
+    enddo; enddo !} i,j
+
+    do j = jsc, jec ; do i = isc, iec ; do k = 1, nk  !{
+       cfc%wc_vert_int_cfc11(i,j) = cfc%wc_vert_int_cfc11(i,j) + (cfc%p_cfc11(i,j,k,tau) * rho_dzt(i,j,k))
+       cfc%wc_vert_int_cfc12(i,j) = cfc%wc_vert_int_cfc12(i,j) + (cfc%p_cfc12(i,j,k,tau) * rho_dzt(i,j,k))
+    enddo; enddo; enddo  !} i,j,k
+
     if (cfc%id_fgcfc11 .gt. 0)            &
         used = g_send_data(cfc%id_fgcfc11,  cfc%stf_gas_cfc11,   &
         model_time, rmask = grid_tmask(:,:,1),&
@@ -477,6 +517,16 @@ subroutine generic_CFC_update_from_source(tracer_list,rho_dzt,dzt,hblt_depth,&
         model_time, rmask = grid_tmask(:,:,1),&
         is_in=isc, js_in=jsc, ie_in=iec, je_in=jec)
 
+    if (cfc%id_wc_vert_int_cfc11 .gt. 0)       &
+       used = g_send_data(cfc%id_wc_vert_int_cfc11, cfc%wc_vert_int_cfc11, &
+       model_time, rmask = grid_tmask(:,:,1),&
+       is_in=isc, js_in=jsc, ie_in=iec, je_in=jec)
+
+    if (cfc%id_wc_vert_int_cfc12 .gt. 0)       &
+       used = g_send_data(cfc%id_wc_vert_int_cfc12, cfc%wc_vert_int_cfc12, &
+       model_time, rmask = grid_tmask(:,:,1),&
+       is_in=isc, js_in=jsc, ie_in=iec, je_in=jec)
+
     return
   end subroutine generic_CFC_update_from_source
 
@@ -655,6 +705,8 @@ end subroutine generic_CFC_set_boundary_values
   subroutine generic_CFC_end
     character(len=fm_string_len), parameter :: sub_name = 'generic_CFC_end'
 
+    call user_deallocate_arrays
+
   end subroutine generic_CFC_end
 
 

generic_tracers/generic_SF6.F90

@@ -108,10 +108,18 @@ module generic_SF6
 
   type generic_SF6_type
     integer :: &
-      id_fgsf6      = -1
+      id_fgsf6 = -1, &
+      id_wc_vert_int_sf6 = -1
+
+    real, dimension(:,:), ALLOCATABLE :: &
+      wc_vert_int_sf6
+
     real, dimension (:,:), pointer :: &
       stf_gas_sf6
 
+    real, dimension(:,:,:,:), pointer :: &
+      p_sf6
+
   end type generic_SF6_type
 
   type(generic_SF6_type) :: sf6
@@ -157,7 +165,7 @@ subroutine generic_SF6_init(tracer_list)
     call user_add_params
 
     !Allocate and initiate all the private work arrays used by this module.
-    !    call user_allocate_arrays !None for SF6 module currently
+    call user_allocate_arrays !None for SF6 module currently
 
   end subroutine generic_SF6_init
 
@@ -192,14 +200,27 @@ subroutine generic_SF6_register_diag(diag_list)
          init_time, vardesc_temp%longname,vardesc_temp%units, missing_value = missing_value1, &
          standard_name="surface_downward_mole_flux_of_sf6")
 
+    vardesc_temp = vardesc("wc_vert_int_sf6","Total SF6 vertical integral",'h','1','s','mol m-2','f')
+    sf6%id_wc_vert_int_sf6 = register_diag_field(package_name, vardesc_temp%name, axes(1:2),&
+         init_time, vardesc_temp%longname,vardesc_temp%units, missing_value = missing_value1)
+
   end subroutine generic_SF6_register_diag
 
 
   subroutine user_allocate_arrays
-    !Allocate all the private arrays.
-    !None for SF6 module currently
+    integer :: isc,iec,jsc,jec,isd,ied,jsd,jed,nk,ntau,n
+    call g_tracer_get_common(isc,iec,jsc,jec,isd,ied,jsd,jed,nk,ntau) 
+
+    allocate(sf6%wc_vert_int_sf6(isd:ied, jsd:jed))  ; sf6%wc_vert_int_sf6=0.0
+
   end subroutine user_allocate_arrays
 
+  subroutine user_deallocate_arrays
+
+    deallocate(sf6%wc_vert_int_sf6)
+
+  end subroutine user_deallocate_arrays
+
   !
   !   This is an internal sub, not a public interface.
   !   Add all the parameters to be used in this module. 
@@ -387,6 +408,7 @@ subroutine generic_SF6_update_from_source(tracer_list,rho_dzt,dzt,hblt_depth,&
 
     character(len=fm_string_len), parameter :: sub_name = 'generic_SF6_update_from_source'
     integer :: isc,iec, jsc,jec,isd,ied,jsd,jed,nk,ntau 
+    integer :: i,j,k
     real, dimension(:,:,:) ,pointer :: grid_tmask
     integer, dimension(:,:),pointer :: mask_coast, grid_kmt
 
@@ -395,13 +417,28 @@ subroutine generic_SF6_update_from_source(tracer_list,rho_dzt,dzt,hblt_depth,&
     call g_tracer_get_common(isc,iec,jsc,jec,isd,ied,jsd,jed,nk,ntau,&
          grid_tmask=grid_tmask,grid_mask_coast=mask_coast,grid_kmt=grid_kmt)
 
-    call g_tracer_get_pointer(tracer_list,'sf6','stf_gas',sf6%stf_gas_sf6)
- 
+    call g_tracer_get_pointer(tracer_list,'sf6', 'stf_gas', sf6%stf_gas_sf6)
+    call g_tracer_get_pointer(tracer_list,'sf6', 'field',   sf6%p_sf6)
+
+    !-- calculate water column vertical integrals
+    do j = jsc, jec ; do i = isc, iec !{
+       sf6%wc_vert_int_sf6(i,j) = 0.0
+    enddo; enddo !} i,j
+
+    do j = jsc, jec ; do i = isc, iec ; do k = 1, nk  !{
+       sf6%wc_vert_int_sf6(i,j) = sf6%wc_vert_int_sf6(i,j) + (sf6%p_sf6(i,j,k,tau) * rho_dzt(i,j,k))
+    enddo; enddo; enddo  !} i,j,k
+
     if (sf6%id_fgsf6 .gt. 0)            &
         used = g_send_data(sf6%id_fgsf6,  sf6%stf_gas_sf6,   &
         model_time, rmask = grid_tmask(:,:,1),&
         is_in=isc, js_in=jsc, ie_in=iec, je_in=jec)
 
+    if (sf6%id_wc_vert_int_sf6 .gt. 0)       &
+       used = g_send_data(sf6%id_wc_vert_int_sf6, sf6%wc_vert_int_sf6, &
+       model_time, rmask = grid_tmask(:,:,1),&
+       is_in=isc, js_in=jsc, ie_in=iec, je_in=jec)
+
     return
   end subroutine generic_SF6_update_from_source
 
@@ -468,6 +505,7 @@ subroutine generic_SF6_set_boundary_values(tracer_list,ST,SSS,rho,ilb,jlb,taum1)
     allocate(g_sf6_csurf(isd:ied, jsd:jed)); g_sf6_csurf=0.0
     allocate(sc_no(isd:ied, jsd:jed))
 
+
     !The atmospheric code needs soluabilities in units of mol/m3/atm
     !
     !MOM
@@ -550,6 +588,8 @@ end subroutine generic_SF6_set_boundary_values
   subroutine generic_SF6_end
     character(len=fm_string_len), parameter :: sub_name = 'generic_SF6_end'
 
+    call user_deallocate_arrays
+
   end subroutine generic_SF6_end