function ESMF_DistGridCreateRDTF(minIndexPTile, maxIndexPTile, regDecomp, &
decompflag, deLabelList, indexflag, connectionList, fastAxis, vm, rc)
!
! !RETURN VALUE:
type(ESMF_DistGrid) :: ESMF_DistGridCreateRDTF
!
! !ARGUMENTS:
integer, intent(in) :: minIndexPTile(:,:)
integer, intent(in) :: maxIndexPTile(:,:)
integer, intent(in), optional :: regDecomp(:,:)
type(ESMF_Decomp_Flag),target, intent(in), optional :: decompflag(:,:)
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 regular decomposition. A regular
! decomposition is of the same rank as the tile and decomposes
! each dimension into a fixed number of DEs. A regular decomposition of a
! multi-tile DistGrid is expressed by a list of DE count vectors, one
! vector for each tile. Each vector contained in the
! {\tt regDecomp} argument ascribes DE counts for each dimension. It is
! erroneous to provide more tiles than there are DEs.
!
! 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[{[regDecomp]}]
! List of DE counts for each dimension. The second
! index indicates the tile number. The default decomposition will
! be {\tt deCount}$ \times 1 \times ... \times 1$. The value of
! {\tt deCount} for a default DELayout equals {\tt petCount}, i.e. the
! default decomposition will be into as many DEs as there are
! PETs and the distribution will be 1 DE per PET.
! \item[{[decompflag]}]
! List of decomposition flags indicating how each dimension of each
! tile is to be divided between the DEs. The default setting
! is {\tt ESMF\_DECOMP\_BALANCED} in all dimensions for all tiles.
! See section \ref{const:decompflag} for a list of valid decomposition
! options. The second index indicates the tile number.
! \item[{[deLabelList]}]
! List assigning DE labels to the default sequence of DEs. The default
! sequence is given by the column major order of the {\tt regDecomp}
! elements in the sequence as they appear following the tile index.
! \item[{[indexflag]}]
! Indicates whether the indices provided by the {\tt minIndex} and
! {\tt maxIndex} 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 minIndex} and {\tt maxIndex}, 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_DistGridCreateRDTF = 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 (present(regDecomp)) continue
!DUMMY TEST TO QUIET DOWN COMPILER WARNINGS
!TODO: Remove the following dummy test when dummy argument actually used
if (present(decompflag)) 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_DistGridCreateRDTF = distgrid
! Set init code
ESMF_INIT_SET_CREATED(ESMF_DistGridCreateRDTF)
! return successfully
!if (present(rc)) rc = ESMF_SUCCESS TODO: enable once implemented
end function ESMF_DistGridCreateRDTF