ESMF_GridCompIsPetLocal Function

public recursive function ESMF_GridCompIsPetLocal(gridcomp, keywordEnforcer, rc)

Arguments

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

Return Value logical


Calls

proc~~esmf_gridcompispetlocal~~CallsGraph proc~esmf_gridcompispetlocal ESMF_GridCompIsPetLocal proc~esmf_compispetlocal ESMF_CompIsPetLocal proc~esmf_gridcompispetlocal->proc~esmf_compispetlocal proc~esmf_gridcompgetinit ESMF_GridCompGetInit proc~esmf_gridcompispetlocal->proc~esmf_gridcompgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_gridcompispetlocal->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_gridcompispetlocal->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_gridcompispetlocal~~CalledByGraph proc~esmf_gridcompispetlocal ESMF_GridCompIsPetLocal proc~esmfio_create ESMFIO_Create proc~esmfio_create->proc~esmf_gridcompispetlocal proc~esmfio_fieldaccess ESMFIO_FieldAccess proc~esmfio_fieldaccess->proc~esmf_gridcompispetlocal proc~esmfio_read ESMFIO_Read proc~esmfio_read->proc~esmf_gridcompispetlocal proc~esmfio_read->proc~esmfio_fieldaccess proc~ioncclose IONCClose proc~esmfio_read->proc~ioncclose proc~ioncopen IONCOpen proc~esmfio_read->proc~ioncopen proc~esmfio_write ESMFIO_Write proc~esmfio_write->proc~esmf_gridcompispetlocal proc~esmfio_write->proc~esmfio_fieldaccess proc~esmfio_write->proc~ioncclose proc~ionccreate IONCCreate proc~esmfio_write->proc~ionccreate proc~ioncclose->proc~esmf_gridcompispetlocal proc~ionccreate->proc~esmf_gridcompispetlocal proc~ioncopen->proc~esmf_gridcompispetlocal proc~loopdatadependentinitialize loopDataDependentInitialize proc~loopdatadependentinitialize->proc~esmf_gridcompispetlocal program~esmf_compsetservutest ESMF_CompSetServUTest program~esmf_compsetservutest->proc~esmf_gridcompispetlocal program~esmf_comptunnelutest ESMF_CompTunnelUTest program~esmf_comptunnelutest->proc~esmf_gridcompispetlocal proc~initializeipdv02p5data InitializeIPDv02p5Data proc~initializeipdv02p5data->proc~loopdatadependentinitialize program~esmf_iocomputest ESMF_IOCompUTest program~esmf_iocomputest->proc~esmfio_create program~esmf_iocomputest->proc~esmfio_read program~esmf_iocomputest->proc~esmfio_write proc~initializeipdv02p5 InitializeIPDv02p5 proc~initializeipdv02p5->proc~initializeipdv02p5data proc~initializegeneric InitializeGeneric proc~initializegeneric->proc~initializeipdv02p5

Source Code

  recursive function ESMF_GridCompIsPetLocal(gridcomp, keywordEnforcer, rc)
!
! !RETURN VALUE:
    logical :: ESMF_GridCompIsPetLocal
!
! !ARGUMENTS:
    type(ESMF_GridComp), intent(in)            :: gridcomp
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\_GridComp} 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[gridcomp]
!   {\tt ESMF\_GridComp} 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_GridCompIsPetLocal = .false.

    ESMF_INIT_CHECK_DEEP(ESMF_GridCompGetInit,gridcomp,rc)

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

    ESMF_GridCompIsPetLocal = localresult

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