NUOPC restart change

[cacraigucar]

From email from Jim Edwards:

In PR ESCOMP/CMEPS#221 I added support for the REST_OPTION=end and for writing restart files at the
end of the run in any case except when REST_OPTION = none or never.

Each component model will need updates in the xxx_comp_nuopc.F90 file order to implement this change. Please consider making this change in your next component tag. Let me know if you have any questions or concerns. thanks

Here are the changes I made in the ctsm lnd_comp_nuopc.F90 file:

(Declare a module variable)

logical :: write_restart_at_endofrun = .false.

(Initialize the variable in InitializeRealize)

+    call NUOPC_CompAttributeGet(gcomp, name="write_restart_at_endofrun", value=cvalue, isPresent=isPresent, isSet=isSet, rc=rc)
+    if (ChkErr(rc,__LINE__,u_FILE_u)) return
+    if (isPresent .and. isSet) then
+       if (trim(cvalue) .eq. '.true.') write_restart_at_endofrun = .true.
+    end if

(Check the variable in ModelAdvance - Note here that this comes after the alarm_stop)

   !--------------------------------                                                                                                              
   ! Determine if time to stop                                                                                                                    
   !--------------------------------                                                                                                              
                                                                                                                                                 
   call ESMF_ClockGetAlarm(clock, alarmname='alarm_stop', alarm=alarm, rc=rc)                                                                    
   if (ChkErr(rc,__LINE__,u_FILE_u)) return                                                                                                      
                                                                                                                                                 
   if (ESMF_AlarmIsRinging(alarm, rc=rc)) then                                                                                                    
      if (ChkErr(rc,__LINE__,u_FILE_u)) return                                                                                                    
      nlend = .true.                                                                                                                              
      call ESMF_AlarmRingerOff( alarm, rc=rc )                                                                                                    
      if (ChkErr(rc,__LINE__,u_FILE_u)) return                                                                                                    
   else                                                                                                                                          
      nlend = .false.                                                                                                                            
   endif                                                                                                                                          
                                                                                                                                                 
   !--------------------------------                                                                                                              
   ! Determine if time to write restart                                                                                                          
   !--------------------------------                                                                                                              
   rstwr = .false.                                                                                                                                
   if (nlend .and. write_restart_at_endofrun) then                                                                                                
      rstwr = .true.                                                                                                                              
   else                                                                                                                                          
      call ESMF_ClockGetAlarm(clock, alarmname='alarm_restart', alarm=alarm, rc=rc)                                                              
      if (ChkErr(rc,__LINE__,u_FILE_u)) return                                                                                                    
      if (ESMF_AlarmIsCreated(alarm, rc=rc)) then                                                                                                
         if (ESMF_AlarmIsRinging(alarm, rc=rc)) then                                                                                              
            if (ChkErr(rc,__LINE__,u_FILE_u)) return                                                                                              
            rstwr = .true.                                                                                                                        
            call ESMF_AlarmRingerOff( alarm, rc=rc )                                                                                              
            if (ChkErr(rc,__LINE__,u_FILE_u)) return                                                                                              
         endif                                                                                                                                    
      endif                                                                                                                                      
   end if                                                                                                                                        

[fvitt]

@cacraigucar,
I tried to implement these changes. However the changes cause restarts to fail when the cmeps mediator is used. I don't have time to deal with this. Can this issue be assigned to someone else?

[cacraigucar]

@fvitt - Yes, you do not need to include this in your PR

@jedwards4b - Francis notes that these changes cause restart failures. Any ideas?

[cacraigucar]

From email from @jedwards4b

The ERS test is broken by this change, I believe that it's a failing of this test and maybe a couple of others that needs to be corrected, however if you are using cmeps0.13.23 or newer it should work.

I know that implementing this change was outside of Francis's assignment but providing minimal information about what component versions were used and what test(s) failed would be really helpful.

[cacraigucar]

From email from @fvitt

Maybe the cmeps tag was too old. My sandbox was using cmeps0.13.13

These are the restart tests I tried:
ERP_D_Vnuopc_Ln9.f09_f09_mg17.F2000climo.cheyenne_intel.cam-outfrq9s
ERP_Vnuopc_Ln9.f09_f09_mg17.FC2000climo.cheyenne_intel.cam-outfrq9s

[gold2718]

Should have been closed by #423 (but bad formatting above, oops).