subroutine ESMF_ArraySetDefault(array, keywordEnforcer, computationalLWidth, &
computationalUWidth, name, rc)
!
! !ARGUMENTS:
type(ESMF_Array), intent(inout) :: array
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
integer, intent(in), optional :: computationalLWidth(:,:)
integer, intent(in), optional :: computationalUWidth(:,:)
character(len = *), intent(in), optional :: name
integer, intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
! Sets adjustable settings in an {\tt ESMF\_Array} object. Arrays with
! tensor dimensions will set values for {\em all} tensor components.
!
! The arguments are:
! \begin{description}
! \item [array]
! {\tt ESMF\_Array} object for which to set properties.
! \item[{[computationalLWidth]}]
! \begin{sloppypar}
! This argument must have of size {\tt (dimCount, localDeCount)}.
! {\tt computationalLWidth} specifies the lower corner of the
! computational region with respect to the lower corner of the exclusive
! region for all local DEs.
! \end{sloppypar}
! \item[{[computationalUWidth]}]
! \begin{sloppypar}
! This argument must have of size {\tt (dimCount, localDeCount)}.
! {\tt computationalUWidth} specifies the upper corner of the
! computational region with respect to the upper corner of the exclusive
! region for all local DEs.
! \end{sloppypar}
! \item [{[name]}]
! The Array name.
! \item [{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOP
!------------------------------------------------------------------------------
integer :: localrc ! local return code
type(ESMF_InterArray) :: computationalLWidthArg ! helper variable
type(ESMF_InterArray) :: computationalUWidthArg ! 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_ArrayGetInit, array, rc)
! Set the name in Base object
if (present(name)) then
if (array%isNamedAlias) then
array%name = trim(name)
else
call c_ESMC_SetName(array, "Array", name, localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
endif
endif
! Deal with (optional) array arguments
computationalLWidthArg = &
ESMF_InterArrayCreate(farray2D=computationalLWidth, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
computationalUWidthArg = &
ESMF_InterArrayCreate(farray2D=computationalUWidth, 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_ArraySet(array, computationalLWidthArg, &
computationalUWidthArg, localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! Garbage collection
call ESMF_InterArrayDestroy(computationalLWidthArg, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
call ESMF_InterArrayDestroy(computationalUWidthArg, 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_ArraySetDefault