ESMF_ContainerGarbageClear Subroutine

public subroutine ESMF_ContainerGarbageClear(container, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Container), intent(inout) :: container
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Calls

proc~~esmf_containergarbageclear~~CallsGraph proc~esmf_containergarbageclear ESMF_ContainerGarbageClear c_esmc_containergarbageclear c_esmc_containergarbageclear proc~esmf_containergarbageclear->c_esmc_containergarbageclear proc~esmf_containergetinit ESMF_ContainerGetInit proc~esmf_containergarbageclear->proc~esmf_containergetinit proc~esmf_imerr ESMF_IMErr proc~esmf_containergarbageclear->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_containergarbageclear->proc~esmf_logfounderror proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep 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_containergarbageclear~~CalledByGraph proc~esmf_containergarbageclear ESMF_ContainerGarbageClear program~esmf_containerutest ESMF_ContainerUTest program~esmf_containerutest->proc~esmf_containergarbageclear

Source Code

  subroutine ESMF_ContainerGarbageClear(container, keywordEnforcer, rc)
!
! !ARGUMENTS:
    type(ESMF_Container), intent(inout)           :: container
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,              intent(out),  optional  :: rc
!         
! !DESCRIPTION:
!   Clear garbage in an {\tt ESMF\_Container} object.
!
!   The arguments are:
!   \begin{description}
!   \item[container]
!     {\tt ESMF\_Container} object to clear garbage for.
!   \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 failure until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP_SHORT(ESMF_ContainerGetInit, container, rc)
    
    ! Call into the C++ interface layer
    call c_ESMC_ContainerGarbageClear(container, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return
 
    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS
 
  end subroutine ESMF_ContainerGarbageClear