ESMF_CompIsPetLocal Function

public recursive function ESMF_CompIsPetLocal(compp, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CompClass), pointer :: compp
integer, intent(out), optional :: rc

Return Value logical


Calls

proc~~esmf_compispetlocal~~CallsGraph proc~esmf_compispetlocal ESMF_CompIsPetLocal proc~esmf_basegetstatus ESMF_BaseGetStatus proc~esmf_compispetlocal->proc~esmf_basegetstatus proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compispetlocal->proc~esmf_compclassgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_compispetlocal->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_compispetlocal->proc~esmf_logfounderror proc~esmf_logseterror ESMF_LogSetError proc~esmf_compispetlocal->proc~esmf_logseterror proc~esmf_basegetstatus->proc~esmf_logfounderror c_esmc_basegetstatus c_esmc_basegetstatus proc~esmf_basegetstatus->c_esmc_basegetstatus 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_logseterror->esmf_breakpoint proc~esmf_logseterror->proc~esmf_logrc2msg proc~esmf_logseterror->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_compispetlocal~~CalledByGraph proc~esmf_compispetlocal ESMF_CompIsPetLocal proc~esmf_cplcompispetlocal ESMF_CplCompIsPetLocal proc~esmf_cplcompispetlocal->proc~esmf_compispetlocal proc~esmf_gridcompispetlocal ESMF_GridCompIsPetLocal proc~esmf_gridcompispetlocal->proc~esmf_compispetlocal 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 proc~nuopc_connectorset NUOPC_ConnectorSet proc~nuopc_connectorset->proc~esmf_cplcompispetlocal 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 proc~nuopc_driveraddcplcomp NUOPC_DriverAddCplComp proc~nuopc_driveraddcplcomp->proc~nuopc_connectorset program~esmf_iocomputest ESMF_IOCompUTest program~esmf_iocomputest->proc~esmfio_create program~esmf_iocomputest->proc~esmfio_read program~esmf_iocomputest->proc~esmfio_write 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~initializeipdv02p5 InitializeIPDv02p5 proc~initializeipdv02p5->proc~initializeipdv02p5data

Source Code

  recursive function ESMF_CompIsPetLocal(compp, rc)
!
! !RETURN VALUE:
    logical :: ESMF_CompIsPetLocal
!
! !ARGUMENTS:
    type(ESMF_CompClass), pointer               :: compp
    integer,              intent(out), optional :: rc             

!
! !DESCRIPTION:
!  Inquire if this component 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.
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    type(ESMF_Status)       :: baseStatus

    ! Initialize return code; assume not implemented until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
        
    ! Initialize output in case of error
    ESMF_CompIsPetLocal = .false.

    ! Test incoming compp object
    if (.not.associated(compp)) then
      call ESMF_LogSetError(ESMF_RC_OBJ_BAD, &
        msg="Not a valid pointer to ESMF Component object", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_CompClassGetInit, compp, rc)

    call ESMF_BaseGetStatus(compp%base, baseStatus, rc=localrc)
    if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
        
    if (baseStatus /= ESMF_STATUS_READY) then
      call ESMF_LogSetError(ESMF_RC_OBJ_BAD, &
        msg="uninitialized or destroyed Component object", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif
    
    ESMF_CompIsPetLocal = compp%iAmParticipant
 
    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end function ESMF_CompIsPetLocal