ESMF_VMIdCompare Function

public function ESMF_VMIdCompare(vmId1, vmId2, keyOnly, keySuper, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_VMId), intent(in) :: vmId1
type(ESMF_VMId), intent(in) :: vmId2
logical, intent(in), optional :: keyOnly
logical, intent(in), optional :: keySuper
integer, intent(out), optional :: rc

Return Value logical


Calls

proc~~esmf_vmidcompare~~CallsGraph proc~esmf_vmidcompare ESMF_VMIdCompare c_esmc_vmidcompare c_esmc_vmidcompare proc~esmf_vmidcompare->c_esmc_vmidcompare proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_vmidcompare->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_vmidcompare~~CalledByGraph proc~esmf_vmidcompare ESMF_VMIdCompare proc~esmf_reconcilemulticompcase ESMF_ReconcileMultiCompCase proc~esmf_reconcilemulticompcase->proc~esmf_vmidcompare proc~esmf_statereconcileisnoop ESMF_StateReconcileIsNoop proc~esmf_statereconcileisnoop->proc~esmf_vmidcompare proc~updategeneric ESMF_InfoDescribe%updateGeneric proc~updategeneric->proc~esmf_vmidcompare program~esmf_vmbroadcastutest ESMF_VMBroadcastUTest program~esmf_vmbroadcastutest->proc~esmf_vmidcompare proc~esmf_statereconcile ESMF_StateReconcile proc~esmf_statereconcile->proc~esmf_statereconcileisnoop proc~esmf_statereconcile_driver ESMF_StateReconcile_driver proc~esmf_statereconcile_driver->proc~esmf_reconcilemulticompcase proc~updatewitharray ESMF_InfoDescribe%updateWithArray proc~updatewitharray->proc~updategeneric proc~updatewitharraybundle ESMF_InfoDescribe%updateWithArrayBundle proc~updatewitharraybundle->proc~updategeneric proc~updatewithcplcomp ESMF_InfoDescribe%updateWithCplComp proc~updatewithcplcomp->proc~updategeneric proc~updatewithdistgrid ESMF_InfoDescribe%updateWithDistGrid proc~updatewithdistgrid->proc~updategeneric proc~updatewithfield ESMF_InfoDescribe%updateWithField proc~updatewithfield->proc~updategeneric proc~updatewithfieldbundle ESMF_InfoDescribe%updateWithFieldBundle proc~updatewithfieldbundle->proc~updategeneric proc~updatewithgrid ESMF_InfoDescribe%updateWithGrid proc~updatewithgrid->proc~updategeneric proc~updatewithgridcomp ESMF_InfoDescribe%updateWithGridComp proc~updatewithgridcomp->proc~updategeneric proc~updatewithlocstream ESMF_InfoDescribe%updateWithLocStream proc~updatewithlocstream->proc~updategeneric proc~updatewithmesh ESMF_InfoDescribe%updateWithMesh proc~updatewithmesh->proc~updategeneric proc~updatewithroutehandle ESMF_InfoDescribe%updateWithRouteHandle proc~updatewithroutehandle->proc~updategeneric proc~updatewithscicomp ESMF_InfoDescribe%updateWithSciComp proc~updatewithscicomp->proc~updategeneric proc~updatewithstate ESMF_InfoDescribe%updateWithState proc~updatewithstate->proc~updategeneric proc~updatewithxgrid ESMF_InfoDescribe%updateWithXGrid proc~updatewithxgrid->proc~updategeneric

Source Code

  function ESMF_VMIdCompare(vmId1, vmId2, keyOnly, keySuper, rc)
!
! !RETURN VALUE:
    logical :: ESMF_VMIdCompare
!
! !ARGUMENTS:
    type(ESMF_VMId),   intent(in)            :: vmId1
    type(ESMF_VMId),   intent(in)            :: vmId2
    logical,           intent(in),  optional :: keyOnly
    logical,           intent(in),  optional :: keySuper
    integer,           intent(out), optional :: rc
!
! !DESCRIPTION:
!   Compare two ESMF_VMId objects.
!
!   The arguments are:
!   \begin{description}
!   \item[vmId1]
!        ESMF_VMId object 1
!   \item[vmId2]
!        ESMF_VMId object 2
!   \item[{[keyOnly]}]
!        For {\tt .true.} only compare the vmKey parts. Default is
!        {\tt .false.}.
!   \item[{[keySuper]}]
!        Only considered when {\tt keyOnly=.true.}!!!
!        For {\tt .true.} return {\tt .true.} for {\tt vmId1} keys whose active
!        bits are a superset (not necessarily strict) of bits active in
!        {\tt vmId2}. Return {\tt .false.} otherwise.
!        Default is {\tt .false.}, i.e. an exact key match is needed to return
!        {\tt .true.}.
!   \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, keyOnlyOpt, keySuperOpt

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    keyOnlyOpt = ESMF_FALSE
    if (present(keyOnly)) then
      if (keyOnly) keyOnlyOpt = ESMF_TRUE
    endif

    keySuperOpt = ESMF_FALSE
    if (present(keySuper)) then
      if (keySuper) keySuperOpt = ESMF_TRUE
    endif

    ! Call into the C++ interface
    call c_ESMC_VMIdCompare(vmId1, vmId2, keyOnlyOpt, keySuperOpt, tf, localrc)
    ESMF_VMIdCompare = tf == ESMF_TRUE
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

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

  end function ESMF_VMIdCompare