Flexible restart write times (restart_fh) for med, ocn, ice, wav #2419
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| module shr_is_restart_fh_mod | ||
|
|
||
| ! Common methods for components to check if it's time to write forecast hour-based restarts | ||
|
|
||
| !use dshr_methods_mod , only : chkerr | ||
| use ESMF, only : ESMF_ConfigCreate, ESMF_ConfigDestroy, ESMF_ConfigLoadFile, & | ||
| ESMF_ConfigGetLen, ESMF_ConfigGetAttribute, ESMF_TimePrint, & | ||
| ESMF_LOGMSG_INFO, ESMF_LogWrite, ESMF_TimeInterval, & | ||
| ESMF_Time, ESMF_KIND_R8, ESMF_Config, ESMF_Clock, & | ||
| ESMF_TimeIntervalSet, ESMF_TimePrint, operator(+), operator(==), & | ||
| ESMF_LogFoundError, ESMF_LOGERR_PASSTHRU | ||
|
|
||
| implicit none | ||
| private | ||
|
|
||
| type :: is_restart_fh_type | ||
| logical :: write_restartfh = .false. | ||
| type(ESMF_Time), allocatable :: restartFhTimes(:) | ||
| end type is_restart_fh_type | ||
|
|
||
| public :: init_is_restart_fh, is_restart_fh, finalize_restart_fh, is_restart_fh_type | ||
|
|
||
| contains | ||
|
|
||
| !----------------------------------------------------------------------- | ||
| subroutine init_is_restart_fh(currentTime, dtime, lLog, restartfh_info) | ||
| ! | ||
| ! !DESCRIPTION: | ||
| ! Process restart_fh attribute from model_configure in UFS | ||
| ! | ||
| ! !USES: | ||
| ! | ||
| ! !ARGUMENTS: | ||
| type(ESMF_Time), intent(in) :: currentTime | ||
| integer, intent(in) :: dtime ! time step (s) | ||
| logical, intent(in) :: lLog ! If true, this task logs restart_fh info | ||
| type(is_restart_fh_type), intent(out) :: restartfh_info !restart_fh info for each task | ||
| ! | ||
| ! !LOCAL VARIABLES: | ||
| character(len=256) :: timestr | ||
| integer :: n, nfh, fh_s, rc | ||
| logical :: isPresent | ||
| real(kind=ESMF_KIND_R8), allocatable :: restart_fh(:) | ||
| type(ESMF_TimeInterval) :: fhInterval | ||
| type(ESMF_Config) :: CF_mc | ||
| !----------------------------------------------------------------------- | ||
|
|
||
| ! set up Times to write non-interval restarts | ||
| inquire(FILE='model_configure', EXIST=isPresent) | ||
| if (isPresent) then !model_configure exists. this is ufs run | ||
| CF_mc = ESMF_ConfigCreate(rc=rc) | ||
| call ESMF_ConfigLoadFile(config=CF_mc,filename='model_configure' ,rc=rc) | ||
| if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return | ||
|
|
||
| nfh = ESMF_ConfigGetLen(config=CF_mc, label ='restart_fh:',rc=rc) | ||
| if (nfh .gt. 0) then | ||
| allocate(restart_fh(1:nfh)) | ||
| allocate(restartfh_info%restartFhTimes(1:nfh)) !not deallocated here | ||
|
|
||
| call ESMF_ConfigGetAttribute(CF_mc,valueList=restart_fh,label='restart_fh:', rc=rc) | ||
| if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return | ||
| ! create a list of times at each restart_fh | ||
| do n = 1,nfh | ||
| fh_s = NINT(3600*restart_fh(n)) | ||
| call ESMF_TimeIntervalSet(fhInterval, s=fh_s, rc=rc) | ||
| if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return | ||
| restartfh_info%restartFhTimes(n) = currentTime + fhInterval | ||
| call ESMF_TimePrint(restartfh_info%restartFhTimes(n), options="string", & | ||
| preString="restart_fh at ", unit=timestr, rc=rc) | ||
| if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return | ||
| if (lLog) then | ||
| if (mod(fh_s,dtime) /= 0) then | ||
| call ESMF_LogWrite('restart time NOT to be written for '//trim(timestr), ESMF_LOGMSG_INFO) | ||
| else | ||
| call ESMF_LogWrite('restart time to be written for '//trim(timestr), ESMF_LOGMSG_INFO) | ||
| end if | ||
| end if | ||
| end do | ||
| deallocate(restart_fh) | ||
| end if !nfh>0 | ||
| call ESMF_ConfigDestroy(CF_mc, rc=rc) | ||
| if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return | ||
| end if !model_configure | ||
|
|
||
| end subroutine init_is_restart_fh | ||
|
|
||
| subroutine is_restart_fh(clock, restartfh_info, lWrite) | ||
| ! | ||
| ! !DESCRIPTION: | ||
| ! True/false if time to write restart | ||
| ! | ||
| ! !USES: | ||
| use ESMF, only : ESMF_ClockGetNextTime | ||
|
|
||
| ! | ||
| ! !ARGUMENTS: | ||
| type(ESMF_Clock), intent(in) :: clock | ||
| type(is_restart_fh_type), intent(inout) :: restartfh_info | ||
| logical, intent(out) :: lWrite ! time to write? | ||
| ! | ||
| ! !LOCAL VARIABLES: | ||
| integer :: nfh, rc | ||
| type(ESMF_Time) :: nextTime | ||
| !----------------------------------------------------------------------- | ||
|
|
||
| restartfh_info%write_restartfh = .false. | ||
| if (allocated(restartfh_info%restartFhTimes)) then | ||
| ! check if next time is == to any restartfhtime | ||
| do nfh = 1,size(restartfh_info%restartFhTimes) | ||
| call ESMF_ClockGetNextTime(clock, nextTime=nexttime, rc=rc) | ||
| if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, line=__LINE__, file=__FILE__)) return | ||
| if (nextTime == restartfh_info%restartFhTimes(nfh)) restartfh_info%write_restartfh = .true. | ||
| end do | ||
| end if | ||
|
|
||
| lWrite = restartfh_info%write_restartfh | ||
|
|
||
| end subroutine is_restart_fh | ||
|
|
||
| subroutine finalize_restart_fh(restartfh_info) | ||
| ! | ||
| ! !DESCRIPTION: | ||
| ! Clean-up...release allocated memory | ||
| ! | ||
| ! !USES: | ||
| ! | ||
| ! !ARGUMENTS: | ||
| type(is_restart_fh_type), intent(inout) :: restartfh_info | ||
| ! | ||
| ! !LOCAL VARIABLES: | ||
| !----------------------------------------------------------------------- | ||
|
|
||
| if (allocated(restartfh_info%restartFhTimes)) deallocate(restartfh_info%restartFhTimes) | ||
|
|
||
| end subroutine finalize_restart_fh | ||
|
|
||
| end module shr_is_restart_fh_mod | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Submodule WW3
updated
2 files
| +2 −0 | model/src/cmake/src_list.cmake | |
| +14 −1 | model/src/wav_comp_nuopc.F90 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why can't you use the cleaner form ? I see it commented out.
Add
use dshr_methods_mod , only : chkerr
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can, but that brings additional dependencies into this module besides ESMF. There are also quite some duplicate ChkErr functions floating around all just wrapping an ESMF function