recursive subroutine ic_final(comp, importState, exportState, clock, rc)
type(ESMF_CplComp) :: comp
type(ESMF_State) :: importState, exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
! Local variables
integer :: userrc
character(ESMF_MAXSTR) :: prefix
character(ESMF_MAXSTR) :: output, pString
type(ESMF_Clock) :: clockCopy
integer :: phase
character(NUOPC_PhaseMapStringLength) :: phaseLabel
logical :: clockIsCreated
! Initialize user return code
rc = ESMF_SUCCESS
call prefixString(comp, prefix=prefix, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
call ESMF_CplCompGet(comp, currentPhase=phase, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! format phase
write(pString,*) phase
call NUOPC_CompSearchPhaseMapByIndex(comp, ESMF_METHOD_FINALIZE, &
phaseIndex=phase, phaseLabel=phaseLabel, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
!---------------------------------------------------------------------------
! Start Compliance Checking: FinalizePrologue
if (ccfDepth <= maxDepth .or. maxDepth < 0) then
if (outputJSON) then
call JSON_LogCtrlFlow("start_prologue", comp, rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, file=FILENAME)) return ! bail out
endif
write(output,*) ">START FinalizePrologue for phase:", &
trim(adjustl(pString)), ": ", trim(phaseLabel)
call NUOPC_ComplianceLogWrite(trim(prefix)//trim(output), &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! compliance check importState
call NUOPC_CheckState(prefix, referenceName="importState", state=importState, &
rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! compliance check exportState
call NUOPC_CheckState(prefix, referenceName="exportState", state=exportState, &
rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! compliance check clock usage
! call NUOPC_CheckClockUsageIncoming(prefix, clock=clock, clockCopy=clockCopy, rc=rc)
! if (ESMF_LogFoundError(rc, &
! line=__LINE__, &
! file=FILENAME)) &
! return ! bail out
! check Component statistics
! call NUOPC_CheckComponentStatistics(prefix, comp=comp, rc=rc)
! if (ESMF_LogFoundError(rc, &
! line=__LINE__, &
! file=FILENAME)) &
! return ! bail out
write(output,*) ">STOP FinalizePrologue for phase:", &
trim(adjustl(pString)), ": ", trim(phaseLabel)
call NUOPC_ComplianceLogWrite(trim(prefix)//trim(output), &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
if (outputJSON) then
call JSON_LogCtrlFlow("stop_prologue", comp, rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, file=FILENAME)) return ! bail out
call JSON_LogCtrlFlow("start_phase", comp, rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, file=FILENAME)) return ! bail out
endif
endif
! Stop Compliance Checking: FinalizePrologue
!---------------------------------------------------------------------------
ccfDepth = ccfDepth + 1
! Call the actual Finalize routine
call ESMF_CplCompFinalizeAct(comp, importState, exportState, clock, &
phase=phase, userRc=userrc, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
ccfDepth = ccfDepth - 1
!---------------------------------------------------------------------------
! Start Compliance Checking: FinalizeEpilogue
if (ccfDepth <= maxDepth .or. maxDepth < 0) then
if (outputJSON) then
call JSON_LogCtrlFlow("stop_phase", comp, rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, file=FILENAME)) return ! bail out
call JSON_LogCtrlFlow("start_epilogue", comp, rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, file=FILENAME)) return ! bail out
endif
call prefixString(comp, prefix=prefix, forward=.false., rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
write(output,*) ">START FinalizeEpilogue for phase:", &
trim(adjustl(pString)), ": ", trim(phaseLabel)
call NUOPC_ComplianceLogWrite(trim(prefix)//trim(output), &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! check Component statistics
! call NUOPC_CheckComponentStatistics(prefix, comp=comp, rc=rc)
! if (ESMF_LogFoundError(rc, &
! line=__LINE__, &
! file=FILENAME)) &
! return ! bail out
! compliance check importState
call NUOPC_CheckState(prefix, referenceName="importState", state=importState, &
rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! compliance check exportState
call NUOPC_CheckState(prefix, referenceName="exportState", state=exportState, &
rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
! compliance check clock usage
! call NUOPC_CheckClockUsageOutgoing(prefix, clock=clock, clockCopy=clockCopy, rc=rc)
! if (ESMF_LogFoundError(rc, &
! line=__LINE__, &
! file=FILENAME)) &
! return ! bail out
write(output,*) ">STOP FinalizeEpilogue for phase:", &
trim(adjustl(pString)), ": ", trim(phaseLabel)
call NUOPC_ComplianceLogWrite(trim(prefix)//trim(output), &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, &
file=FILENAME)) &
return ! bail out
if (outputJSON) then
call JSON_LogCtrlFlow("stop_epilogue", comp, rc)
if (ESMF_LogFoundError(rc, &
line=__LINE__, file=FILENAME)) return ! bail out
endif
endif
! Stop Compliance Checking: FinalizeEpilogue
!---------------------------------------------------------------------------
! if not bailed for other reasons then pass back the actual userrc
rc = userrc
end subroutine ic_final