Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_GridComp), | intent(in) | :: | gridcomp | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
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