ESMF_VMGetCurrentGarbageInfo Subroutine

public subroutine ESMF_VMGetCurrentGarbageInfo(fobjCount, objCount, rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(out) :: fobjCount
integer, intent(out) :: objCount
integer, intent(out), optional :: rc

Calls

proc~~esmf_vmgetcurrentgarbageinfo~~CallsGraph proc~esmf_vmgetcurrentgarbageinfo ESMF_VMGetCurrentGarbageInfo c_esmc_vmgetcurrentgarbageinfo c_esmc_vmgetcurrentgarbageinfo proc~esmf_vmgetcurrentgarbageinfo->c_esmc_vmgetcurrentgarbageinfo proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_vmgetcurrentgarbageinfo->proc~esmf_logfounderror esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_vmgetcurrentgarbageinfo~~CalledByGraph proc~esmf_vmgetcurrentgarbageinfo ESMF_VMGetCurrentGarbageInfo proc~checkcomponentstatistics checkComponentStatistics proc~checkcomponentstatistics->proc~esmf_vmgetcurrentgarbageinfo proc~nuopc_checkcomponentstatistics NUOPC_CheckComponentStatistics proc~nuopc_checkcomponentstatistics->proc~esmf_vmgetcurrentgarbageinfo proc~ic_final ic_final proc~ic_final->proc~nuopc_checkcomponentstatistics proc~ic_final~2 ic_final proc~ic_final~2->proc~checkcomponentstatistics proc~ic_final~3 ic_final proc~ic_final~3->proc~nuopc_checkcomponentstatistics proc~ic_init ic_init proc~ic_init->proc~nuopc_checkcomponentstatistics proc~ic_init~2 ic_init proc~ic_init~2->proc~checkcomponentstatistics proc~ic_init~3 ic_init proc~ic_init~3->proc~nuopc_checkcomponentstatistics proc~ic_run ic_run proc~ic_run->proc~nuopc_checkcomponentstatistics proc~ic_run~2 ic_run proc~ic_run~2->proc~checkcomponentstatistics proc~ic_run~3 ic_run proc~ic_run~3->proc~nuopc_checkcomponentstatistics

Source Code

  subroutine ESMF_VMGetCurrentGarbageInfo(fobjCount, objCount, rc)
!
! !ARGUMENTS:
    integer, intent(out)            :: fobjCount
    integer, intent(out)            :: objCount
    integer, intent(out), optional  :: rc
!
! !DESCRIPTION:
!   Get garbage collection information of the current execution context.
!
!   The arguments are:
!   \begin{description}
!   \item[fobjCount] 
!     Upon return this holds the number of Fortran objects held by the
!     ESMF garbage collection for the current context.
!   \item[objCount] 
!     Upon return this holds the number of Base objects
!     held by the ESMF garbage collection for the current context.
!     Note that {\em every} C++ object in the garbage collection has a Base 
!     object. However, for Fortran objects, {\em most} have also a Base object,
!     but not all of them. E.g. no Base object is created for GeomBase objects!
!   \item[{[rc]}] 
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! Call into the C++ interface.
    call c_esmc_vmgetcurrentgarbageinfo(fobjCount, objCount, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_VMGetCurrentGarbageInfo