Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Base) | :: | base | ||||
logical, | intent(in), | optional | :: | noGarbage | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_BaseDestroy(base, noGarbage, rc) ! ! !ARGUMENTS: type(ESMF_Base) :: base logical, intent(in), optional :: noGarbage integer, intent(out), optional :: rc ! ! !DESCRIPTION: ! Release resources held by a Base object. ! ! \begin{description} ! \item [base] ! An {\tt ESMF\_Base} derived type to be deleted. ! \item[{[noGarbage]}] ! If set to {\tt .TRUE.} the object will be fully destroyed and removed ! from the ESMF garbage collection system. Note however that under this ! condition ESMF cannot protect against accessing the destroyed object ! through dangling aliases -- a situation which may lead to hard to debug ! application crashes. ! ! It is generally recommended to leave the {\tt noGarbage} argument ! set to {\tt .FALSE.} (the default), and to take advantage of the ESMF ! garbage collection system which will prevent problems with dangling ! aliases or incorrect sequences of destroy calls. However this level of ! support requires that a small remnant of the object is kept in memory ! past the destroy call. This can lead to an unexpected increase in memory ! consumption over the course of execution in applications that use ! temporary ESMF objects. For situations where the repeated creation and ! destruction of temporary objects leads to memory issues, it is ! recommended to call with {\tt noGarbage} set to {\tt .TRUE.}, fully ! removing the entire temporary object from memory. ! \item [{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOPI logical :: rcpresent ! Return code present integer :: localrc type(ESMF_Logical) :: opt_noGarbage ! helper variable ! Initialize return code rcpresent = .FALSE. if(present(rc)) then rcpresent = .TRUE. rc = ESMF_RC_NOT_IMPL endif ! check input parameters ESMF_INIT_CHECK_DEEP(ESMF_BaseGetInit,base,rc) ! Set default flags opt_noGarbage = ESMF_FALSE if (present(noGarbage)) opt_noGarbage = noGarbage ! Call into the C++ interface call c_ESMC_BaseDestroy(base, opt_noGarbage, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! Set init code ESMF_INIT_SET_DELETED(base) ! Return successfully if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_BaseDestroy