ESMF_VMIdDestroy_v Subroutine

private subroutine ESMF_VMIdDestroy_v(vmId, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_VMId), intent(inout) :: vmId(:)
integer, intent(out), optional :: rc

Calls

proc~~esmf_vmiddestroy_v~~CallsGraph proc~esmf_vmiddestroy_v ESMF_VMIdDestroy_v c_esmc_vmiddestroy c_esmc_vmiddestroy proc~esmf_vmiddestroy_v->c_esmc_vmiddestroy proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_vmiddestroy_v->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_vmiddestroy_v~~CalledByGraph proc~esmf_vmiddestroy_v ESMF_VMIdDestroy_v interface~esmf_vmiddestroy ESMF_VMIdDestroy interface~esmf_vmiddestroy->proc~esmf_vmiddestroy_v proc~esmf_statereconcile_driver ESMF_StateReconcile_driver proc~esmf_statereconcile_driver->interface~esmf_vmiddestroy proc~esmf_vmtranslatevmid ESMF_VMTranslateVMId proc~esmf_statereconcile_driver->proc~esmf_vmtranslatevmid proc~esmf_vmtranslatevmid->interface~esmf_vmiddestroy program~esmf_infocacheutest ESMF_InfoCacheUTest program~esmf_infocacheutest->interface~esmf_vmiddestroy program~esmf_infocacheutest->proc~esmf_vmtranslatevmid program~esmf_vmallgathervutest ESMF_VMAllGatherVUTest program~esmf_vmallgathervutest->interface~esmf_vmiddestroy program~esmf_vmbroadcastutest ESMF_VMBroadcastUTest program~esmf_vmbroadcastutest->interface~esmf_vmiddestroy proc~esmf_statereconcile ESMF_StateReconcile proc~esmf_statereconcile->proc~esmf_statereconcile_driver

Source Code

  subroutine ESMF_VMIdDestroy_v(vmId, rc)
!
! !ARGUMENTS:
    type(ESMF_VMId),   intent(inout)         :: vmId(:)
    integer,           intent(out), optional :: rc
!
! !DESCRIPTION:
!   Destroy an ESMF_VMId object. This frees memory on the C side.
!
!   The arguments are:
!   \begin{description}
!   \item[vmId] 
!        Array of ESMF_VMId objects
!   \item[{[rc]}] 
!        Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    integer                 :: i

    ! 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
    do, i=1, size (vmId)
      call c_ESMC_VMIdDestroy(vmId(i), localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
          ESMF_CONTEXT, rcToReturn=rc)) return
    end do

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

  end subroutine ESMF_VMIdDestroy_v