ESMF_VMPlanDestruct Subroutine

public subroutine ESMF_VMPlanDestruct(vmplan, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_VMPlan), intent(inout) :: vmplan
integer, intent(out), optional :: rc

Calls

proc~~esmf_vmplandestruct~~CallsGraph proc~esmf_vmplandestruct ESMF_VMPlanDestruct c_esmc_vmplandestruct c_esmc_vmplandestruct proc~esmf_vmplandestruct->c_esmc_vmplandestruct proc~esmf_imerr ESMF_IMErr proc~esmf_vmplandestruct->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_vmplandestruct->proc~esmf_logfounderror proc~esmf_vmplangetinit ESMF_VMPlanGetInit proc~esmf_vmplandestruct->proc~esmf_vmplangetinit 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_vmplandestruct~~CalledByGraph proc~esmf_vmplandestruct ESMF_VMPlanDestruct proc~esmf_compdestruct ESMF_CompDestruct proc~esmf_compdestruct->proc~esmf_vmplandestruct proc~esmf_cplcompdestroy ESMF_CplCompDestroy proc~esmf_cplcompdestroy->proc~esmf_compdestruct proc~esmf_gridcompdestroy ESMF_GridCompDestroy proc~esmf_gridcompdestroy->proc~esmf_compdestruct proc~esmf_scicompdestroy ESMF_SciCompDestroy proc~esmf_scicompdestroy->proc~esmf_compdestruct proc~f_esmf_compcollectgarbage1 f_esmf_compcollectgarbage1 proc~f_esmf_compcollectgarbage1->proc~esmf_compdestruct proc~f_esmf_compcollectgarbage2 f_esmf_compcollectgarbage2 proc~f_esmf_compcollectgarbage2->proc~esmf_compdestruct

Source Code

  subroutine ESMF_VMPlanDestruct(vmplan, rc)
!
! !ARGUMENTS:
    type(ESMF_VMPlan), intent(inout)  :: vmplan
    integer, intent(out), optional    :: rc
!
! !DESCRIPTION:
!   Destruct a vmplan.
!
!   The arguments are:
!   \begin{description}
!   \item[vmplan] 
!        VMPlan
!   \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

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_VMPlanGetInit, vmplan, rc)
    
    ! Call into the C++ interface.
    call c_ESMC_VMPlanDestruct(vmplan, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return
      
    ! Set init code
    ESMF_INIT_SET_DELETED(vmplan)
 
    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS
 
  end subroutine ESMF_VMPlanDestruct