Add repeatCount to cap restart file

* Add repeatCount.

* Add repeatCount to cap_restart.yaml

* Add repeatCount.

* Add repeatCount to cap_restart.yaml

* Update to include repeatCount in make_clock

* Update CHANGELOG.md

* Make sure has_repeatCount has a value.

Author: darianboggs

CHANGELOG.md

@@ -89,6 +89,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add tests of update_payload and update_from_payload for VerticalGridAspect
 - Add `use_field_dictionary` column to ACG3 with new unit tests.
 - Update cap restart file with current time at end of run.
+- Read/write repeatCount from/to cap restart file at beginning/end of run.
+
 
 ### Changed
 

gridcomps/cap3g/Cap.F90

@@ -19,6 +19,7 @@ module mapl3g_Cap
    character(len=*), parameter :: KEY_RESTART = 'restart'
    character(len=*), parameter :: KEY_CLOCK = 'clock'
    character(len=*), parameter :: KEY_CURRTIME = 'currTime'
+   character(len=*), parameter :: KEY_REPEATCOUNT = 'repeatCount'
 
    type CheckpointOptions
       logical :: is_enabled = .false.
@@ -59,7 +60,7 @@ subroutine mapl_run_driver(hconfig, is_model_pet, unusable, servers, rc)
       call mapl_DriverInitializePhases(driver, phases=GENERIC_INIT_PHASE_SEQUENCE, _RC)
       call integrate(driver, hconfig, options%checkpointing, options%lgr, _RC)
       call driver%finalize(_RC)
-      call update_restart_currTime(hconfig, clock, _RC)
+      call update_restart(hconfig, clock, _RC)
 
       _RETURN(_SUCCESS)
       _UNUSED_DUMMY(unusable)
@@ -341,15 +342,21 @@ function make_clock(hconfig, lgr, rc) result(clock)
       type(ESMF_Time) :: end_of_segment
       type(ESMF_TimeInterval) :: timeStep, segment_duration
       type(ESMF_TimeInterval), allocatable :: repeatDuration
-      logical :: has_repeatDuration
+      logical :: has_repeatDuration, has_repeatCount
       character(:), allocatable :: cap_restart_file
       character(ESMF_MAXSTR) :: iso_time
+      integer(kind=ESMF_KIND_I8) :: repeatCount
 
+      repeatCount = 0
       cap_restart_file = esmf_HConfigAsString(hconfig, keyString=KEY_RESTART, _RC)
       restart_cfg = esmf_HConfigCreate(filename=cap_restart_file, _RC)
       currTime = mapl_HConfigAsTime(restart_cfg, keyString='currTime', _RC)
       iso_time = esmf_HConfigAsString(restart_cfg, keystring='currTime', _RC)
       call lgr%info('current time: %a', trim(iso_time))
+      has_repeatCount = ESMF_HConfigIsDefined(restart_cfg, keyString=KEY_REPEATCOUNT, _RC)
+      if(has_repeatCount) then
+         repeatCount = ESMF_HConfigAsI8(restart_cfg, keyString=KEY_REPEATCOUNT, _RC)
+      end if
       call esmf_HConfigDestroy(restart_cfg, _RC)
 
       clock_cfg = esmf_HConfigCreateAt(hconfig, keystring=KEY_CLOCK, _RC)
@@ -381,6 +388,8 @@ function make_clock(hconfig, lgr, rc) result(clock)
          call lgr%info('repeat duration: %a', trim(iso_time))
       end if
 
+      ! Currently, repeatCount is not an argument for ESMF_ClockCreate or ESMF_ClockSet.
+      ! Once it is added, it should be included in the create/set below.
       clock = esmf_ClockCreate(timeStep=timeStep, &
            startTime=startTime, stopTime=end_of_segment, &
            refTime=startTime, &
@@ -598,32 +607,31 @@ subroutine make_symlink(checkpointing_path, target_name, rc)
       _RETURN(_SUCCESS)
    end subroutine make_symlink
 
-   subroutine update_restart_currTime(hconfig, clock, rc)
+   subroutine update_restart(hconfig, clock, rc)
       type(ESMF_HConfig), intent(in) :: hconfig
       type(ESMF_Clock), intent(inout) :: clock
       integer, optional, intent(out) :: rc
       integer :: status
-      character(len=:), allocatable :: currTimeString
       type(ESMF_Time) :: currTime
+      integer(kind=ESMF_KIND_I8) :: repeatCount
       logical :: restart_is_defined
       character(:), allocatable :: cap_restart_file
       type(ESMF_HConfig) :: restart_cfg
-      integer, parameter :: ISOSTRING_LENGTH=20
+      integer, parameter :: ISOSTRING_LENGTH = 20
       character(len=ISOSTRING_LENGTH) :: timeString
 
-
-      call ESMF_ClockGet(clock, currTime=currTime, _RC)
+      call ESMF_ClockGet(clock, currTime=currTime, repeatCount=repeatCount, _RC)
       call ESMF_TimeGet(currTime, timeString=timeString, _RC)
-      currTimeString = trim(timeString)
       restart_is_defined = ESMF_HConfigIsDefined(hconfig, keyString=KEY_RESTART, _RC)
       _ASSERT(restart_is_defined, 'Unable to get restart filename')
       cap_restart_file = ESMF_HConfigAsString(hconfig, keyString=KEY_RESTART, _RC)
-      restart_cfg = ESMF_HConfigCreate(filename=cap_restart_file, _RC)
-      call ESMF_HConfigSet(restart_cfg, content=timeString, keyString=KEY_CURRTIME, _RC)
+      restart_cfg = ESMF_HConfigCreate(_RC)
+      call ESMF_HConfigAdd(restart_cfg, content=timeString, addKeyString=KEY_CURRTIME, _RC)
+      call ESMF_HConfigAdd(restart_cfg, content=repeatCount, addKeyString=KEY_REPEATCOUNT, _RC)
       call ESMF_HConfigFileSave(restart_cfg, cap_restart_file, _RC)
       call ESMF_HConfigDestroy(restart_cfg, _RC)
       _RETURN(_SUCCESS)
 
-   end subroutine update_restart_currTime
+   end subroutine update_restart
 
 end module mapl3g_Cap

gridcomps/cap3g/tests/cap_restart_tests/cap.yaml

@@ -6,7 +6,8 @@ cap:
     dt: PT1H
     start: 2001-01-01T00:00:00
     stop: 2999-03-02T21:00:00
-    segment_duration: PT10H
+    segment_duration: PT8H
+    repeat_duration: PT12H
 
   checkpointing:
     enabled: true
@@ -38,10 +39,3 @@ esmf:
 
 mapl:
   model_petcount: 1
-#  pflogger_cfg_file: pflogger.yaml
-#
-#  servers:
-#    pfio:
-#       nodes: 1
-#    mit:
-#       nodes: 0

gridcomps/cap3g/tests/cap_restart_tests/cap_restart_expected.yaml

@@ -1 +1,2 @@
-currTime: 2001-01-01T10:00:00
+currTime: 2001-01-01T08:00:00
+repeatCount: 0

gridcomps/cap3g/tests/cap_restart_tests/history.yaml

@@ -7,8 +7,6 @@ geoms:
     dateline: DC
 
 active_collections:
-  - coll1
-  - coll2
 
 time_specs:
   three_hour: &three_hour

gridcomps/cap3g/tests/run_captest.cmake

@@ -10,9 +10,11 @@ macro(run_case CASE)
       RESULT_VARIABLE CMD_RESULT
       WORKING_DIRECTORY ${tempdir}
       )
-    execute_process(
-      COMMAND ${CMAKE_COMMAND} -E cat ${tempdir}/PET0.ESMF_LogFile
-      )
+    if(EXISTS ${tempdir}/PET0.ESMF_LogFile)
+      execute_process(
+        COMMAND ${CMAKE_COMMAND} -E cat ${tempdir}/PET0.ESMF_LogFile
+        )
+    endif()
     if(NOT CMD_RESULT AND "${CASE}" STREQUAL "cap_restart_tests")
       set(EXPECTED "cap_restart_expected.yaml")
       set(ACTUAL "cap_restart.yaml")
@@ -26,7 +28,8 @@ macro(run_case CASE)
       COMMAND ${CMAKE_COMMAND} -E rm -rf ${tempdir}
       )
     if(CMD_RESULT)
-       message(FATAL_ERROR "Error running ${CASE}")
+       set(MSG "Error running ${CASE}")
+       message(FATAL_ERROR "${MSG}")
     endif()
 endmacro()
 run_case(${TEST_CASE})