Restructure the offline driver.

There is now only one executable being built: either cable-mpi or cable, depending if MPI support is available or not. When MPI support is available, the code will now automatically run the serial driver if using only one MPI process, instead of stopping with an error like before.

CMakeLists.txt

@@ -59,6 +59,7 @@ add_library(
     src/offline/cable_plume_mip.F90
     src/offline/cable_read.F90
     src/offline/cable_site.F90
+    src/offline/cable_serial.F90
     src/offline/cable_soil_params.F90
     src/offline/cable_weathergenerator.F90
     src/offline/cable_write.F90
@@ -158,22 +159,24 @@ if(CABLE_MPI)
   target_link_libraries(cable_common PRIVATE MPI::MPI_Fortran)
 endif()
 
-add_executable(
-    cable
-    src/offline/cable_driver.F90
-)
-target_link_libraries(cable PRIVATE cable_common)
-install(TARGETS cable RUNTIME)
-
 if(CABLE_MPI)
     add_executable(
         cable-mpi
         src/offline/cable_mpicommon.F90
-        src/offline/cable_mpidrv.F90
         src/offline/cable_mpimaster.F90
         src/offline/cable_mpiworker.F90
         src/science/pop/pop_mpi.F90
+        src/offline/cable_offline_driver.F90
     )
     target_link_libraries(cable-mpi PRIVATE cable_common MPI::MPI_Fortran)
     install(TARGETS cable-mpi RUNTIME)
+else()
+    add_executable(
+        cable
+        src/offline/cable_mpimaster_stub.F90
+        src/offline/cable_mpiworker_stub.F90
+        src/offline/cable_offline_driver.F90
+    )
+    target_link_libraries(cable PRIVATE cable_common)
+    install(TARGETS cable RUNTIME)
 endif()

src/coupled/ACCESS-CM2/cable_cbm.F90

@@ -15,7 +15,7 @@
 !          twice per timestep in the ACCESS case. Not all parts of cbm
 !          are executed in each of the ACCESS calls.
 !
-! Called from: cable_driver for offline version
+! Called from: cable_serial for offline version
 !              cable_explicit_driver, cable_implicit_driver for ACCESS
 !
 ! Contact: [email protected]

src/offline/cable_cru_TRENDY.F90

@@ -1260,7 +1260,7 @@ SUBROUTINE CRU_GET_SUBDIURNAL_MET(CRU, MET, CurYear, ktau, kend, LastYearOfMet )
 
     CRU%ktau  = ktau     ! ktau is the current timestep in the year.
 
-!  this only works with CANBERRA cable_driver, as ktau    !
+!  this only works with CANBERRA cable_serial, as ktau    !
 !  restarts on Jan 1                                      !
     ! Based on the ktau timestep, calculate date and time information (the same for the whole spatial dimension.)
     met%hod (:) = REAL(MOD( (ktau-1) * NINT(dt), INT(SecDay)) ) / 3600.  ! Hour of the day

src/offline/cable_mpimaster.F90

@@ -18,7 +18,7 @@
 !          soil_snow_type now ssnow (instead of ssoil)
 !
 !          MPI wrapper developed by Maciej Golebiewski (2012)
-!          Modified from cable_driver.F90 in CABLE-2.0_beta r171 by B Pak
+!          Modified from cable_serial.F90 in CABLE-2.0_beta r171 by B Pak
 !
 ! ==============================================================================
 ! Uses:           mpi

src/offline/cable_mpimaster_stub.F90

@@ -0,0 +1,23 @@
+! CSIRO Open Source Software License Agreement (variation of the BSD / MIT License)
+! Copyright (c) 2015, Commonwealth Scientific and Industrial Research Organisation
+! (CSIRO) ABN 41 687 119 230.
+
+MODULE cable_mpimaster
+  !! Stub for the master driver when MPI is not available.
+  IMPLICIT NONE
+
+  PRIVATE
+  PUBLIC :: mpidrv_master
+
+CONTAINS
+
+  SUBROUTINE mpidrv_master(comm)
+    !! Stub for when MPI is not available
+    INTEGER, INTENT(IN) :: comm
+
+    ! This should never be called!
+    STOP
+
+  END SUBROUTINE mpidrv_master
+
+END MODULE cable_mpimaster

src/offline/cable_mpiworker.F90

@@ -18,7 +18,7 @@
 !          soil_snow_type now ssnow (instead of ssoil)
 !
 !          MPI wrapper developed by Maciej Golebiewski (2012)
-!          Modified from cable_driver.F90 in CABLE-2.0_beta r171 by B Pak
+!          Modified from cable_serial.F90 in CABLE-2.0_beta r171 by B Pak
 !
 ! ==============================================================================
 ! Uses:           mpi

src/offline/cable_mpiworker_stub.F90

@@ -0,0 +1,23 @@
+! CSIRO Open Source Software License Agreement (variation of the BSD / MIT License)
+! Copyright (c) 2015, Commonwealth Scientific and Industrial Research Organisation
+! (CSIRO) ABN 41 687 119 230.
+
+MODULE cable_mpiworker
+  !! Stub for the worker driver when MPI is not available.
+  IMPLICIT NONE
+
+  PRIVATE
+  PUBLIC :: mpidrv_worker
+
+CONTAINS
+
+  SUBROUTINE mpidrv_worker(comm)
+    !! Stub for when MPI is not available
+    INTEGER, INTENT(IN) :: comm
+
+    ! This should never be called!
+    STOP
+
+  END SUBROUTINE mpidrv_worker
+
+END MODULE cable_mpiworker

src/offline/cable_mpidrv.F90 → src/offline/cable_offline_driver.F90

@@ -8,20 +8,10 @@
 ! A copy of the License (CSIRO_BSD_MIT_License_v2.0_CABLE.txt) is located
 ! in each directory containing CABLE code.
 !
-! ==============================================================================
-! Purpose: Bare bones MPI driver for CABLE
-!
-! Contact: [email protected]
-!
-! History: MPI wrapper developed by Maciej Golebiewski (2012)
-!
-! ==============================================================================
-!
-PROGRAM mpi_driver
-  USE mpi
-  USE cable_mpi_mod, ONLY : mpi_grp_t, mpi_mod_init, mpi_mod_end, mpi_check_error
+PROGRAM cable_offline_driver
+  USE cable_mpi_mod, ONLY : mpi_grp_t, mpi_mod_init, mpi_mod_end
   USE cable_driver_init_mod
-
+  USE cable_serial
   USE cable_mpimaster
   USE cable_mpiworker
 
@@ -35,20 +25,19 @@ PROGRAM mpi_driver
 
   CALL cable_driver_init(mpi_grp)
 
-  IF (mpi_grp%size < 2) THEN
-    WRITE(*,*) 'This program needs at least 2 processes to run!'
-    CALL mpi_grp%abort()
-  END IF
-
-  IF (mpi_grp%rank == 0) THEN
-     CALL mpidrv_master (mpi_grp%comm)
+  IF (mpi_grp%size == 1) THEN
+    CALL serialdrv()
   ELSE
-     CALL mpidrv_worker (mpi_grp%comm)
+    IF (mpi_grp%rank == 0) THEN
+      CALL mpidrv_master(mpi_grp%comm)
+    ELSE
+      CALL mpidrv_worker(mpi_grp%comm)
+    END IF
   END IF
 
   CALL mpi_mod_end()
 
   CALL CPU_TIME(etime)
   PRINT *, 'Finished. ', etime, ' seconds needed for '
 
-END PROGRAM mpi_driver
+END PROGRAM cable_offline_driver

src/offline/cable_output.F90

@@ -18,7 +18,7 @@
 !
 !
 ! ==============================================================================
-! CALLed from:    cable_driver.F90
+! CALLed from:    cable_serial.F90
 !
 ! MODULEs used:   cable_abort_module
 !                 cable_common_module

src/offline/cable_plume_mip.F90

@@ -951,7 +951,7 @@ SUBROUTINE PLUME_MIP_GET_MET(PLUME, MET, CurYear, ktau, kend, islast )
     PLUME%CYEAR = CurYear
     PLUME%ktau  = ktau
 
-!  this only works with CANBERRA cable_driver, as ktau    !
+!  this only works with CANBERRA cable_serial, as ktau    !
 !  restarts on Jan 1                                      !
 
     met%hod (:) = REAL(MOD( (ktau-1) * NINT(dt), INT(SecDay)) ) / 3600.

src/offline/cable_read.F90

@@ -17,7 +17,7 @@
 !
 !
 ! ==============================================================================
-! CALLed from:    cable_driver.f90
+! CALLed from:    cable_serial.f90
 ! MODULEs used:   cable_abort_module
 !                 cable_IO_vars_module
 !                 netcdf

src/offline/cable_driver.F90 → src/offline/cable_serial.F90

@@ -58,8 +58,7 @@
 !              poolcnpOut.csv -- from CASA-CNP
 !==============================================================================
 
-PROGRAM cable_offline_driver
-  USE cable_mpi_mod, ONLY : mpi_grp_t, mpi_mod_init, mpi_mod_end
+MODULE cable_serial
   USE cable_driver_init_mod, ONLY : &
     cable_driver_init,              &
     vegparmnew,                     &
@@ -147,6 +146,14 @@ PROGRAM cable_offline_driver
 USE casa_offline_inout_module, ONLY : WRITE_CASA_RESTART_NC, WRITE_CASA_OUTPUT_NC 
   IMPLICIT NONE
 
+  PRIVATE
+  PUBLIC :: serialdrv
+
+CONTAINS
+
+SUBROUTINE serialdrv()
+
+
   ! CABLE namelist: model configuration, runtime/user switches
   !CHARACTER(LEN=200), PARAMETER :: CABLE_NAMELIST='cable.nml'
   ! try to read in namelist from command line argument
@@ -254,7 +261,7 @@ PROGRAM cable_offline_driver
        new_sumbal = 0.0, &
        new_sumfpn = 0.0, &
        new_sumfe = 0.0
-!For consistency w JAC
+  !For consistency w JAC
   REAL,ALLOCATABLE, SAVE :: c1(:,:)
   REAL,ALLOCATABLE, SAVE :: rhoch(:,:)
   REAL,ALLOCATABLE, SAVE :: xk(:,:)
@@ -263,26 +270,18 @@ PROGRAM cable_offline_driver
   INTEGER :: ioerror
   INTEGER :: count_bal = 0
 
-! for landuse
-integer     mlon,mlat, mpx
-real(r_2), dimension(:,:,:),   allocatable,  save  :: luc_atransit
-real(r_2), dimension(:,:),     allocatable,  save  :: luc_fharvw
-real(r_2), dimension(:,:,:),   allocatable,  save  :: luc_xluh2cable
-real(r_2), dimension(:),       allocatable,  save  :: arealand        
-integer,   dimension(:,:),     allocatable,  save  :: landmask
-integer,   dimension(:),       allocatable,  save  :: cstart,cend,nap
-real(r_2), dimension(:,:,:),   allocatable,  save  :: patchfrac_new
-
-  ! mpi group info
-  TYPE(mpi_grp_t) :: mpi_grp
+  ! for landuse
+  integer     mlon,mlat, mpx
+  real(r_2), dimension(:,:,:),   allocatable,  save  :: luc_atransit
+  real(r_2), dimension(:,:),     allocatable,  save  :: luc_fharvw
+  real(r_2), dimension(:,:,:),   allocatable,  save  :: luc_xluh2cable
+  real(r_2), dimension(:),       allocatable,  save  :: arealand
+  integer,   dimension(:,:),     allocatable,  save  :: landmask
+  integer,   dimension(:),       allocatable,  save  :: cstart,cend,nap
+  real(r_2), dimension(:,:,:),   allocatable,  save  :: patchfrac_new
 
 ! END header
 
-  CALL mpi_mod_init()
-  mpi_grp = mpi_grp_t()
-
-  CALL cable_driver_init(mpi_grp)
-
   cable_runtime%offline = .TRUE.
 
   ! Open, read and close the consistency check file.
@@ -1234,9 +1233,7 @@ PROGRAM cable_offline_driver
   CALL CPU_TIME(etime)
   PRINT *, 'Finished. ', etime, ' seconds needed for ', kend,' hours'
 
-  CALL mpi_mod_end()
-
-END PROGRAM cable_offline_driver
+END SUBROUTINE serialdrv
 
 
 SUBROUTINE prepareFiles(ncciy)
@@ -1372,3 +1369,5 @@ SUBROUTINE LUCdriver( casabiome,casapool, &
   CALL POPLUC_weights_transfer(POPLUC,POP,LUC_EXPT)
 
 END SUBROUTINE LUCdriver
+
+END MODULE cable_serial

src/offline/casa_cable.F90

@@ -12,7 +12,7 @@
 ! Purpose: 
 !          sumcflux  - accumulating carbon fluxes (not required for UM)
 !
-! Called from: cable_driver for offline version
+! Called from: cable_serial for offline version
 !              Not currently called/available for ACCESS version
 !
 ! Contact: [email protected]

src/offline/casa_ncdf.F90

@@ -406,7 +406,7 @@ FUNCTION IS_CASA_TIME(iotype, yyyy, ktau, kstart, koffset, kend, ktauday, logn)
 
   USE cable_common_module, ONLY: CABLE_USER 
     ! Correctly determine if it is time to dump-read or standard-write
-    ! casa output from cable_driver.
+    ! casa output from cable_serial.
     ! Writing casa-dump data is handled in casa_cable and therefore not \
     ! captured here
     !cable_common module was intended to be unequivocally common to all

src/offline/cbl_model_driver_offline.F90

@@ -15,7 +15,7 @@
 !          twice per timestep in the ACCESS case. Not all parts of cbm
 !          are executed in each of the ACCESS calls.
 !
-! Called from: cable_driver for offline version
+! Called from: cable_serial for offline version
 !              cable_explicit_driver, cable_implicit_driver for ACCESS
 !
 ! Contact: [email protected]

src/science/casa-cnp/casa_feedback.F90

@@ -20,7 +20,7 @@
 ! Purpose: bgcdriver - interface between casacnp and cable
 !          sumcflux  - accumulating carbon fluxes (not required for UM)
 !
-! Called from: cable_driver for offline version
+! Called from: cable_serial for offline version
 !              Not currently called/available for ACCESS version
 !
 ! Contact: [email protected]

src/science/casa-cnp/casa_sumcflux.F90

@@ -20,7 +20,7 @@
 ! Purpose: bgcdriver - interface between casacnp and cable
 !          sumcflux  - accumulating carbon fluxes (not required for UM)
 !
-! Called from: cable_driver for offline version
+! Called from: cable_serial for offline version
 !              Not currently called/available for ACCESS version
 !
 ! Contact: [email protected]

src/science/gw_hydro/cable_gw_hydro.F90

@@ -1154,8 +1154,8 @@ SUBROUTINE soil_snow_gw(dels, soil, ssnow, canopy, met, bal, veg)
    !> 18. update variables ! MMY??? where is pudsto calculated
     DO i=1,mp
        ssnow%pudsto(i) = 0.0  !no puddle
-       ssnow%smelt(i)  = ssnow%smelt(i)/dels    !change units to mm/s.  cable_driver then reverts back to mm
-       ssnow%runoff(i) = (ssnow%rnof1(i) + ssnow%rnof2(i))!*dels  !cable_driver converts from mm/s to mm
+       ssnow%smelt(i)  = ssnow%smelt(i)/dels    !change units to mm/s.  cable_serial then reverts back to mm
+       ssnow%runoff(i) = (ssnow%rnof1(i) + ssnow%rnof2(i))!*dels  !cable_serial converts from mm/s to mm
        !rnof1 and rnof2 are already in mm/s
        ! Set weighted soil/snow surface temperature
        ssnow%tss(i) =  (1-ssnow%isflag(i))*ssnow%tgg(i,1) + ssnow%isflag(i)*ssnow%tggsn(i,1)

src/science/misc/cable_climate.F90

@@ -12,7 +12,7 @@
 ! ==============================================================================
 ! Purpose: tracking climate variables for use in phenology and potential pft modules
 !
-! Called from: cable_driver
+! Called from: cable_serial
 !
 ! History: Vanessa Haverd Jan 2015
 

src/science/pop/POPLUC.F90

@@ -12,7 +12,7 @@
 ! Purpose: module for land-use change which interacts with POP demography
 ! via secondary forest age-distribution, and updates casa stocks according to land-use transitions
 !
-! Called from: cable_driver or cable_mpimaster
+! Called from: cable_serial or cable_mpimaster
 !
 ! SUBROUTINES
 ! ZeroPOPLUC(POPLUC)

src/science/sli/cable_sli_main.F90

@@ -236,7 +236,7 @@ SUBROUTINE sli_main(ktau, dt, veg, soil, ssnow, met, canopy, air, rad, SEB_only)
     END WHERE
     h0         = ssnow%h0
 
-    ! zero runoff here, in case error is returned to avoid excessive runoff from previous time-step. (Runoff is multipled by dt in cable_driver.F90)
+    ! zero runoff here, in case error is returned to avoid excessive runoff from previous time-step. (Runoff is multipled by dt in cable_serial.F90)
     ssnow%rnof1 = 0.0
     ssnow%rnof2 = 0.0
     ssnow%runoff = 0.0