Parallel I/O output module enhancements

CMakeLists.txt

@@ -299,14 +299,23 @@ else()
         src/offline/cbl_model_driver_offline.F90
         src/offline/landuse_inout.F90
         src/offline/spincasacnp.F90
+        src/util/aggregator.F90
         src/util/cable_climate_type_mod.F90
         src/util/masks_cbl.F90
         src/util/cable_array_utils.F90
+        src/util/cable_enum.F90
+        src/util/cable_grid_reductions.F90
+        src/util/cable_timing_utils.F90
         src/util/netcdf/cable_netcdf_decomp_util.F90
         src/util/netcdf/cable_netcdf.F90
         src/util/netcdf/cable_netcdf_internal.F90
         src/util/netcdf/cable_netcdf_stub_types.F90
         src/util/netcdf/nf90/cable_netcdf_nf90.F90
+        src/util/io/output/cable_output_core.F90
+        src/util/io/output/cable_output_definitions.F90
+        src/util/io/output/cable_output_types.F90
+        src/util/io/output/cable_output_utils.F90
+        src/util/io/output/cable_output.F90
     )
 
     target_link_libraries(cable_common PRIVATE PkgConfig::NETCDF)

src/offline/cable_define_types.F90

@@ -24,7 +24,8 @@
 !#define UM_BUILD yes
 MODULE cable_def_types_mod
 
-USE cable_climate_type_mod, ONLY: climate_type
+  USE cable_climate_type_mod, ONLY: climate_type
+  USE aggregator_mod, ONLY: aggregator_real32_1d_t, new_aggregator
 
   ! Contains all variables which are not subroutine-internal
 
@@ -531,6 +532,8 @@ MODULE cable_def_types_mod
      ! vh_js ! !litter thermal conductivity (Wm-2K-1) and vapour diffusivity (m2s-1)
      REAL(r_2), DIMENSION(:), POINTER :: kthLitt, DvLitt
 
+     type(aggregator_real32_1d_t), allocatable :: tscrn_max_daily
+     type(aggregator_real32_1d_t), allocatable :: tscrn_min_daily
 
   END TYPE canopy_type
 
@@ -1186,6 +1189,9 @@ SUBROUTINE alloc_canopy_type(var, mp)
     ALLOCATE (var % kthLitt(mp))
     ALLOCATE (var % DvLitt(mp))
 
+    var%tscrn_max_daily = new_aggregator(source_data=var%tscrn); CALL var%tscrn_max_daily%init(method="max")
+    var%tscrn_min_daily = new_aggregator(source_data=var%tscrn); CALL var%tscrn_min_daily%init(method="min")
+
   END SUBROUTINE alloc_canopy_type
 
   ! ------------------------------------------------------------------------------
@@ -1811,6 +1817,9 @@ SUBROUTINE dealloc_canopy_type(var)
     DEALLOCATE (var % kthLitt)
     DEALLOCATE (var % DvLitt)
 
+    DEALLOCATE(var%tscrn_max_daily)
+    DEALLOCATE(var%tscrn_min_daily)
+
   END SUBROUTINE dealloc_canopy_type
 
   ! ------------------------------------------------------------------------------

src/offline/cable_serial.F90

@@ -85,6 +85,7 @@ MODULE cable_serial
        patch_type,landpt,&
        defaultLAI, sdoy, smoy, syear, timeunits, calendar, &
        NO_CHECK
+  use cable_io_vars_module, only: patch
   USE cable_io_decomp_mod, ONLY: io_decomp_t
   USE cable_io_decomp_mod, ONLY: cable_io_decomp_init
   USE casa_ncdf_module, ONLY: is_casa_time
@@ -112,6 +113,16 @@ MODULE cable_serial
        ncid_wd,ncid_mask
   USE cable_output_module,  ONLY: create_restart,open_output_file,            &
        write_output,close_output_file
+  use cable_output_prototype_v2_mod, only: cable_output_mod_init
+  use cable_output_prototype_v2_mod, only: cable_output_mod_end
+  use cable_output_prototype_v2_mod, only: cable_output_register_output_variables
+  use cable_output_prototype_v2_mod, only: cable_output_profiles_init
+  use cable_output_prototype_v2_mod, only: cable_output_update
+  use cable_output_prototype_v2_mod, only: cable_output_write
+  use cable_output_prototype_v2_mod, only: cable_output_write_parameters
+  use cable_output_prototype_v2_mod, only: cable_output_write_restart
+  use cable_output_prototype_v2_mod, only: cable_output_core_outputs
+  use cable_netcdf_mod, only: cable_netcdf_mod_init, cable_netcdf_mod_end
    USE cable_checks_module, ONLY: constant_check_range
   USE cable_write_module,   ONLY: nullify_write
   USE cable_IO_vars_module, ONLY: timeunits,calendar
@@ -273,10 +284,13 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
   real(r_2), dimension(:,:,:),   allocatable,  save  :: patchfrac_new
 
   type(io_decomp_t) :: io_decomp
+
+  integer :: start_year
 ! END header
 
 ! INISTUFF
 
+  call cable_netcdf_mod_init(mpi_grp)
 
   ! outer loop - spinup loop no. ktau_tot :
   ktau     = 0
@@ -462,6 +476,12 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
 
           call cable_io_decomp_init(io_decomp)
 
+          if (.not. casaonly) then
+            call cable_output_mod_init(io_decomp)
+            call cable_output_register_output_variables(cable_output_core_outputs(canopy, soil))
+            call cable_output_profiles_init()
+          end if
+
         ENDIF ! CALL 1
 
         ! globally (WRT code) accessible kend through USE cable_common_module
@@ -572,6 +592,17 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
             IF ( CABLE_USER%POPLUC) CALL POPLUC_set_patchfrac(POPLUC,LUC_EXPT)
           ENDIF
 
+          ! TODO(Sean): this is a hack for determining if the current time step
+          ! is the last of the month. Better way to do this?
+          IF(ktau == 1) THEN
+            !MC - use met%year(1) instead of CABLE_USER%YearStart for non-GSWP forcing and leap years
+            IF ( TRIM(cable_user%MetType) .EQ. '' ) THEN
+                start_year = met%year(1)
+            ELSE
+                start_year = CABLE_USER%YearStart
+            ENDIF
+          END IF
+
           IF ( .NOT. CASAONLY ) THEN
 
             ! Feedback prognostic vcmax and daily LAI from casaCNP to CABLE
@@ -581,6 +612,13 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
             IF (l_laiFeedbk.AND.icycle>0) veg%vlai(:) = casamet%glai(:)
 
             IF (.NOT. allocated(c1)) ALLOCATE( c1(mp,nrb), rhoch(mp,nrb), xk(mp,nrb) )
+
+            if (ktau > kstart .and. mod(ktau - kstart, ktauday) == 0) then
+              ! Reset daily aggregators if previous time step was the end of day
+              call canopy%tscrn_max_daily%reset()
+              call canopy%tscrn_min_daily%reset()
+            end if
+
             ! Call land surface scheme for this timestep, all grid points:
             CALL cbm( ktau, dels, air, bgc, canopy, met, bal,                             &
                  rad, rough, soil, ssnow, sum_flux, veg, climate, xk, c1, rhoch )
@@ -595,9 +633,8 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
             ssnow%rnof2 = ssnow%rnof2*dels
             ssnow%runoff = ssnow%runoff*dels
 
-
-
-
+            call canopy%tscrn_max_daily%accumulate()
+            call canopy%tscrn_min_daily%accumulate()
 
           ELSE IF ( IS_CASA_TIME("dread", yyyy, ktau, kstart, &
                 koffset, kend, ktauday, logn) ) THEN                ! CLN READ FROM FILE INSTEAD !
@@ -722,6 +759,9 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
               CALL write_output( dels, ktau, met, canopy, casaflux, casapool, casamet, &
                    ssnow, rad, bal, air, soil, veg, CSBOLTZ, CEMLEAF, CEMSOIL )
             END SELECT
+            if (ktau == kstart) call cable_output_write_parameters(kstart, patch, landpt, met)
+            call cable_output_update(ktau, dels, leaps, start_year, met)
+            call cable_output_write(ktau, dels, leaps, start_year, met, patch, landpt)
           ENDIF
 
 
@@ -1004,16 +1044,20 @@ SUBROUTINE serialdrv(NRRRR, dels, koffset, kend, GSWP_MID, PLUME, CRU, site, mpi
 
   IF ( .NOT. CASAONLY.and. .not. l_landuse ) THEN
     ! Write restart file if requested:
-    IF(output%restart)                                           &
+    IF(output%restart) then
       CALL create_restart( logn, dels, ktau, soil, veg, ssnow,  &
            canopy, rough, rad, bgc, bal, met )
+      call cable_output_write_restart(current_time=ktau * dels)
+    end if
     !mpidiff
     IF (cable_user%CALL_climate) &
       CALL WRITE_CLIMATE_RESTART_NC ( climate, ktauday )
 
+    call cable_output_mod_end()
     !--- LN ------------------------------------------[
   ENDIF
 
+  call cable_netcdf_mod_end()
 
 
   IF ( TRIM(cable_user%MetType) .NE. "gswp" .AND. &