ESMF_CplCompIsPetLocal Function

public recursive function ESMF_CplCompIsPetLocal(cplcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(in) :: cplcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value logical


Calls

proc~~esmf_cplcompispetlocal~~CallsGraph proc~esmf_cplcompispetlocal ESMF_CplCompIsPetLocal proc~esmf_compispetlocal ESMF_CompIsPetLocal proc~esmf_cplcompispetlocal->proc~esmf_compispetlocal proc~esmf_cplcompgetinit ESMF_CplCompGetInit proc~esmf_cplcompispetlocal->proc~esmf_cplcompgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_cplcompispetlocal->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_cplcompispetlocal->proc~esmf_logfounderror proc~esmf_compispetlocal->proc~esmf_imerr proc~esmf_compispetlocal->proc~esmf_logfounderror proc~esmf_basegetstatus ESMF_BaseGetStatus proc~esmf_compispetlocal->proc~esmf_basegetstatus proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compispetlocal->proc~esmf_compclassgetinit proc~esmf_logseterror ESMF_LogSetError proc~esmf_compispetlocal->proc~esmf_logseterror 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 proc~esmf_basegetstatus->proc~esmf_logfounderror c_esmc_basegetstatus c_esmc_basegetstatus proc~esmf_basegetstatus->c_esmc_basegetstatus c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg proc~esmf_logseterror->esmf_breakpoint proc~esmf_logseterror->proc~esmf_logrc2msg proc~esmf_logseterror->proc~esmf_logwrite 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_cplcompispetlocal~~CalledByGraph proc~esmf_cplcompispetlocal ESMF_CplCompIsPetLocal proc~nuopc_connectorset NUOPC_ConnectorSet proc~nuopc_connectorset->proc~esmf_cplcompispetlocal proc~nuopc_driveraddcplcomp NUOPC_DriverAddCplComp proc~nuopc_driveraddcplcomp->proc~nuopc_connectorset program~esmf_nuopc_utest ESMF_NUOPC_UTest program~esmf_nuopc_utest->proc~nuopc_connectorset interface~nuopc_driveraddcomp NUOPC_DriverAddComp interface~nuopc_driveraddcomp->proc~nuopc_driveraddcplcomp proc~initializeipdv02p1 InitializeIPDv02p1 proc~initializeipdv02p1->interface~nuopc_driveraddcomp proc~nuopc_driveringestrunsequenceff NUOPC_DriverIngestRunSequenceFF proc~nuopc_driveringestrunsequenceff->interface~nuopc_driveraddcomp proc~setmodelservices SetModelServices proc~setmodelservices->interface~nuopc_driveraddcomp proc~setmodelservices~2 SetModelServices proc~setmodelservices~2->interface~nuopc_driveraddcomp proc~setmodelservices~3 SetModelServices proc~setmodelservices~3->interface~nuopc_driveraddcomp

Source Code

  recursive function ESMF_CplCompIsPetLocal(cplcomp, keywordEnforcer, rc)
!
! !RETURN VALUE:
    logical :: ESMF_CplCompIsPetLocal
!
! !ARGUMENTS:
    type(ESMF_CplComp), intent(in)            :: cplcomp
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,            intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
! Inquire if this {\tt ESMF\_CplComp} object is to execute on the calling PET.
!
! The return value is {\tt .true.} if the component is to execute on the
! calling PET, {\tt .false.} otherwise.
!
! The arguments are:
! \begin{description}
! \item[cplcomp]
!   {\tt ESMF\_CplComp} queried.
! \item[{[rc]}]
!   Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer :: localrc                     ! local error status
    logical :: localresult

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

    ! Initialize output value in case of error
    ESMF_CplCompIsPetLocal = .false.

    ESMF_INIT_CHECK_DEEP(ESMF_CplCompGetInit,cplcomp,rc)

    ! call Comp method
    localresult = ESMF_CompIsPetLocal(cplcomp%compp, rc=localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ESMF_CplCompIsPetLocal = localresult

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS
  end function ESMF_CplCompIsPetLocal