function ESMF_DistGridCreateDBTF(minIndexPTile, maxIndexPTile, deBlockList, &
deLabelList, indexflag, connectionList, fastAxis, vm, rc)
!
! !RETURN VALUE:
type(ESMF_DistGrid) :: ESMF_DistGridCreateDBTF
!
! !ARGUMENTS:
integer, intent(in) :: minIndexPTile(:,:)
integer, intent(in) :: maxIndexPTile(:,:)
integer, intent(in) :: deBlockList(:,:,:)
integer, intent(in), optional :: deLabelList(:)
type(ESMF_Index_Flag), intent(in), optional :: indexflag
type(ESMF_DistGridConnection), intent(in), optional :: connectionList(:)
integer, intent(in) :: fastAxis
type(ESMF_VM), intent(in), optional :: vm
integer, intent(out), optional :: rc
!
! !DESCRIPTION:
! Create an {\tt ESMF\_DistGrid} on multiple logically
! rectangular tiles with decomposition specified by {\tt deBlockList}.
!
! The arguments are:
! \begin{description}
! \item[minIndexPTile]
! The first index provides the index space tuple of the lower
! corner of a tile. The second index indicates the tile number.
! \item[maxIndexPTile]
! The first index provides the index space tuple of the upper
! corner of a tile. The second index indicates the tile number.
! \item[deBlockList]
! List of DE-local blocks. The third index of {\tt deBlockList}
! steps through the deBlock elements (i.e. deCount), which are defined
! by the first two indices.
! The first index must be of size {\tt dimCount} and the
! second index must be of size 2. Each element of {\tt deBlockList}
! defined by the first two indices hold the following information.
! \begin{verbatim}
! +---------------------------------------> 2nd index
! | 1 2
! | 1 minIndex(1) maxIndex(1)
! | 2 minIndex(2) maxIndex(2)
! | . minIndex(.) maxIndex(.)
! | .
! v
! 1st index
! \end{verbatim}
! It is required that there be no overlap between the DE blocks.
! \item[{[deLabelList]}]
! List assigning DE labels to the default sequence of DEs. The default
! sequence is given by the order of DEs in the {\tt deBlockList}
! argument.
! \item[{[indexflag]}]
! Indicates whether the indices provided by the {\tt minIndexPTile} and
! {\tt maxIndexPTile} arguments are forming a global index space or
! not. This does {\em not} affect the indices held by the DistGrid
! object, which are always identical to what was specified by
! {\tt minIndexPTile} and {\tt maxIndexPTile}, regardless of the
! {\tt indexflag} setting. However, it does affect whether an
! {\tt ESMF\_Array} object created on the DistGrid can choose global
! indexing or not. The default is {\tt ESMF\_INDEX\_DELOCAL}.
! See section \ref{const:indexflag} for a complete list of options.
! \item[{[connectionList]}]
! List of {\tt ESMF\_DistGridConnection} objects, defining connections
! between DistGrid tiles in index space.
! See section \ref{api:DistGridConnectionSet} for the associated Set()
! method.
! \item[fastAxis]
! Integer value indicating along which axis fast communication is
! requested. This hint will be used during DELayout creation.
! \item[{[vm]}]
! Optional {\tt ESMF\_VM} object of the current context. Providing the
! VM of the current context will lower the method's overhead.
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOPI
!------------------------------------------------------------------------------
integer :: localrc ! local return code
type(ESMF_DistGrid) :: distgrid ! opaque pointer to new C++ DistGrid
! initialize return code; assume routine not implemented
localrc = ESMF_RC_NOT_IMPL
if (present(rc)) rc = ESMF_RC_NOT_IMPL
! Initialize the pointer to NULL
distgrid%this = ESMF_NULL_POINTER
ESMF_DistGridCreateDBTF = distgrid
! Check init status of arguments
ESMF_INIT_CHECK_DEEP(ESMF_VMGetInit, vm, rc)
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (size(minIndexPTile) == size(minIndexPTile)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (size(maxIndexPTile) == size(maxIndexPTile)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (size(deBlockList) == size(deBlockList)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (present(deLabelList)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (present(indexflag)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (present(connectionList)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (fastaxis == fastaxis) continue
! Call into the C++ interface, which will sort out optional arguments.
! call c_ESMC_DistGridCreateRDF(distgrid, minIndexAux, maxIndexAux, &
! regDecompAux, opt_decompflag, len_decompflag, deLabelListAux, indexflag, &
! connectionListAux, fastAxis, vm, localrc)
! if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
! ESMF_CONTEXT, rcToReturn=rc)) return
! Set return value
ESMF_DistGridCreateDBTF = distgrid
! Set init code
ESMF_INIT_SET_CREATED(ESMF_DistGridCreateDBTF)
! return successfully
!if (present(rc)) rc = ESMF_SUCCESS TODO: enable once implemented
end function ESMF_DistGridCreateDBTF