subroutine ESMF_DistGridGetPLocalDePDim(distgrid, localDe, dim, &
indexList, keywordEnforcer, rc)
!
! !ARGUMENTS:
type(ESMF_DistGrid), intent(in) :: distgrid
integer, intent(in) :: localDe
integer, intent(in) :: dim
integer, target, intent(out) :: indexList(:)
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:
! Access internal DistGrid information.
!
! The arguments are:
! \begin{description}
! \item[distgrid]
! Queried {\tt ESMF\_DistGrid} object.
! \item[localDe]
! Local DE for which information is requested. {\tt [0,..,localDeCount-1]}
! \item[dim]
! Dimension for which information is requested. {\tt [1,..,dimCount]}
! \item[indexList]
! Upon return this holds the list of DistGrid tile-local indices
! for {\tt localDe} along dimension {\tt dim}. The supplied variable
! must be at least of size {\tt indexCountPDe(dim, localDeToDeMap(localDe))}.
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOP
!------------------------------------------------------------------------------
integer :: localrc ! local return code
type(ESMF_InterArray) :: indexListAux ! helper variable
! initialize return code; assume routine not implemented
localrc = ESMF_RC_NOT_IMPL
if (present(rc)) rc = ESMF_RC_NOT_IMPL
! Check init status of arguments
ESMF_INIT_CHECK_DEEP(ESMF_DistGridGetInit, distgrid, rc)
! Deal with (optional) array arguments
indexListAux = ESMF_InterArrayCreate(indexList, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! call into the C++ interface, which will sort out optional arguments
call c_ESMC_DistGridGetPLocalDePDim(distgrid, localDe, dim, indexListAux, &
localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! garbage collection
call ESMF_InterArrayDestroy(indexListAux, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! return successfully
if (present(rc)) rc = ESMF_SUCCESS
end subroutine ESMF_DistGridGetPLocalDePDim