Add comments about the ordering of the stop and restart alarms

ekluzek · Dec 21, 2024 · 3b8c132 · 3b8c132
1 parent fe0ec28
commit 3b8c132
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/src/cpl/nuopc/lnd_comp_nuopc.F90 b/src/cpl/nuopc/lnd_comp_nuopc.F90
@@ -1040,9 +1040,10 @@ subroutine ModelSetRunClock(gcomp, rc)
        if (ChkErr(rc,__LINE__,u_FILE_u)) return
        call ESMF_LogWrite(subname//'setting alarms for ' // trim(name), ESMF_LOGMSG_INFO)
 
-       !----------------
+       !----------------------------------------------------------------------------------
        ! Stop alarm
-       !----------------
+       ! MUST be set before the restart alarm in case restarts happen at the stop alarm
+       !----------------------------------------------------------------------------------
        call NUOPC_CompAttributeGet(gcomp, name="stop_option", value=stop_option, rc=rc)
        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
@@ -1064,9 +1065,10 @@ subroutine ModelSetRunClock(gcomp, rc)
        call ESMF_AlarmSet(stop_alarm, clock=mclock, rc=rc)
        if (ChkErr(rc,__LINE__,u_FILE_u)) return
 
-       !----------------
+       !----------------------------------------------------------------------------------
        ! Restart alarm
-       !----------------
+       ! MUST be set after the stop alarm in case restarts happen at the stop alarm
+       !----------------------------------------------------------------------------------
        call NUOPC_CompAttributeGet(gcomp, name="restart_option", value=restart_option, rc=rc)
        if (ChkErr(rc,__LINE__,u_FILE_u)) return