ESMF_VMIdGet Subroutine

  subroutine ESMF_VMIdGet(vmId, leftMostOnBit, isLocalPetActive, rc)
!
! !ARGUMENTS:
    type(ESMF_VMId),   intent(in)            :: vmId
    integer,           intent(out), optional :: leftMostOnBit
    logical,           intent(out), optional :: isLocalPetActive
    integer,           intent(out), optional :: rc
!
! !DESCRIPTION:
!   Copy the contents of ESMF_VMId objects.  Note that the destination
!   objects must have been (deeply) allocated prior to calling this
!   copy.
!
!   The arguments are:
!   \begin{description}
!   \item[vmId]
!        VMId to get information from.
!   \item[{[leftMostOnBit]}]
!        The index (base 0) of the leftmost on bit in {\tt vmId}. If the index
!        is -1, then there were no on bits.
!   \item[{[isLocalPetActive]}]
!        Set to {\tt .true.} if the local PET is indicated as active in
!        {\tt vmId}.
!   \item[{[rc]}]
!        Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    type(ESMF_Logical)      :: tf

    ! 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
    if (present(leftMostOnBit)) then
       call c_ESMCI_VMIdGetLeftMostOnBit(vmId, leftMostOnBit, localrc)
       if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return
    endif
    if (present(isLocalPetActive)) then
       call c_ESMCI_VMIdGetIsLocalPetActive(vmId, tf, localrc)
       if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return
       isLocalPetActive = tf == ESMF_TRUE
    endif

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

  end subroutine ESMF_VMIdGet