subroutine ESMF_GridGetCoordBounds(grid, coordDim, keywordEnforcer, &
staggerloc, localDE, exclusiveLBound, exclusiveUBound, &
exclusiveCount, computationalLBound, computationalUBound , &
computationalCount, totalLBound, totalUBound, totalCount, rc)
!
! !ARGUMENTS:
type(ESMF_Grid), intent(in) :: grid
integer, intent(in) :: coordDim
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
type (ESMF_StaggerLoc), intent(in), optional :: staggerloc
integer, intent(in), optional :: localDE
integer, target, intent(out), optional :: exclusiveLBound(:)
integer, target, intent(out), optional :: exclusiveUBound(:)
integer, target, intent(out), optional :: exclusiveCount(:)
integer, target, intent(out), optional :: computationalLBound(:)
integer, target, intent(out), optional :: computationalUBound(:)
integer, target, intent(out), optional :: computationalCount(:)
integer, target, intent(out), optional :: totalLBound(:)
integer, target, intent(out), optional :: totalUBound(:)
integer, target, intent(out), optional :: totalCount(:)
integer, intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
! This method gets information about the range of index space which a particular
! piece of coordinate data occupies. In other words, this method returns the
! bounds of the coordinate arrays. Note that unlike the output from the
! Array, these values also include the undistributed dimensions and are
! ordered to reflect the order of the indices in the coordinate. So, for example,
! {\tt totalLBound} and {\tt totalUBound} should match the bounds of the Fortran array
! retrieved by {\tt ESMF\_GridGetCoord}.
!
!The arguments are:
!\begin{description}
!\item[grid]
! Grid to get the information from.
!\item[coordDim]
! The coordinate dimension to get the information for (e.g. 1=x).
!\item[{[staggerloc]}]
! The stagger location to get the information for.
! Please see Section~\ref{const:staggerloc} for a list
! of predefined stagger locations. If not present, defaults to
! ESMF\_STAGGERLOC\_CENTER.
!\item[{[localDE]}]
! The local DE for which information is requested. {\tt [0,..,localDECount-1]}.
! For {\tt localDECount==1} the {\tt localDE} argument may be omitted,
! in which case it will default to {\tt localDE=0}.
!\item[{[exclusiveLBound]}]
! Upon return this holds the lower bounds of the exclusive region.
! {\tt exclusiveLBound} must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[exclusiveUBound]}]
! Upon return this holds the upper bounds of the exclusive region.
! {\tt exclusiveUBound} must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[exclusiveCount]}]
! Upon return this holds the number of items, {\tt exclusiveUBound-exclusiveLBound+1},
! in the exclusive region per dimension.
! {\tt exclusiveCount} must
! be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[computationalLBound]}]
! Upon return this holds the lower bounds of the stagger region.
! {\tt computationalLBound} must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[computationalUBound]}]
! Upon return this holds the upper bounds of the stagger region.
! {\tt computationalUBound} must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[computationalCount]}]
! Upon return this holds the number of items in the computational region per dimension
! (i.e. {\tt computationalUBound-computationalLBound+1}). {\tt computationalCount}
! must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[totalLBound]}]
! Upon return this holds the lower bounds of the total region.
! {\tt totalLBound} must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[totalUBound]}]
! Upon return this holds the upper bounds of the total region.
! {\tt totalUBound} must be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
!\item[{[totalCount]}]
! \begin{sloppypar}
! Upon return this holds the number of items in the total region per dimension
! (i.e. {\tt totalUBound-totalLBound+1}). {\tt totalCount} must
! be allocated to be of size equal to the coord dimCount.
! Please see Section~\ref{sec:grid:usage:bounds} for a description
! of the regions and their associated bounds and counts.
! \end{sloppypar}
!\item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!\end{description}
!
!EOP
integer :: localrc ! local error status
type(ESMF_InterArray) :: exclusiveLBoundArg ! helper variable
type(ESMF_InterArray) :: exclusiveUBoundArg ! helper variable
type(ESMF_InterArray) :: exclusiveCountArg ! helper variable
type(ESMF_InterArray) :: computationalLBoundArg ! helper variable
type(ESMF_InterArray) :: computationalUBoundArg ! helper variable
type(ESMF_InterArray) :: computationalCountArg ! helper variable
type(ESMF_InterArray) :: totalLBoundArg ! helper variable
type(ESMF_InterArray) :: totalUBoundArg ! helper variable
type(ESMF_InterArray) :: totalCountArg ! helper variable
integer :: tmp_staggerloc
! Initialize return code
localrc = ESMF_RC_NOT_IMPL
if (present(rc)) rc = ESMF_RC_NOT_IMPL
! Check init status of arguments
ESMF_INIT_CHECK_DEEP(ESMF_GridGetInit, grid, rc)
! handle staggerloc
if (present(staggerloc)) then
tmp_staggerloc=staggerloc%staggerloc
else
tmp_staggerloc=ESMF_STAGGERLOC_CENTER%staggerloc ! default
endif
! process optional arguments
exclusiveLBoundArg=ESMF_InterArrayCreate(exclusiveLBound, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
exclusiveUBoundArg=ESMF_InterArrayCreate(exclusiveUBound, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
exclusiveCountArg=ESMF_InterArrayCreate(exclusiveCount, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
computationalLBoundArg=ESMF_InterArrayCreate(computationalLBound, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
computationalUBoundArg=ESMF_InterArrayCreate(computationalUBound, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
computationalCountArg=ESMF_InterArrayCreate(computationalCount, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
totalLBoundArg=ESMF_InterArrayCreate(totalLBound, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
totalUBoundArg = ESMF_InterArrayCreate(totalUBound, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
totalCountArg = ESMF_InterArrayCreate(totalCount, 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_GridGetCoordBounds(grid, localDE, coordDim, tmp_staggerloc, &
exclusiveLBoundArg, exclusiveUBoundArg, exclusiveCountArg, &
computationalLBoundArg, computationalUBoundArg, computationalCountArg,&
totalLBoundArg, totalUBoundArg, totalCountArg, localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! Deallocate interface ints
call ESMF_InterArrayDestroy(exclusiveLBoundArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(exclusiveUBoundArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(exclusiveCountArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(computationalLBoundArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(computationalUBoundArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(computationalCountArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(totalLBoundArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(totalUBoundArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(totalCountArg, 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_GridGetCoordBounds