subroutine ESMF_ArrayBundleAdd(arraybundle, arrayList, keywordEnforcer, &
multiflag, relaxedflag, rc)
!
! !ARGUMENTS:
type(ESMF_ArrayBundle), intent(inout) :: arraybundle
type(ESMF_Array), intent(in) :: arrayList(:)
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
logical, intent(in), optional :: multiflag
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
! Add Array(s) to an ArrayBundle. It is an error if {\tt arrayList} contains
! Arrays that match by name Arrays already contained in {\tt arraybundle}.
!
! \begin{description}
! \item [arraybundle]
! {\tt ESMF\_ArrayBundle} to be added to.
! \item [arrayList]
! List of {\tt ESMF\_Array} objects to be added.
! \item [{[multiflag]}]
! A setting of {\tt .true.} allows multiple items with the same name
! to be added to {\tt arraybundle}. For {\tt .false.} added items must
! have unique names. The default setting is {\tt .false.}.
! \item [{[relaxedflag]}]
! A setting of {\tt .true.} indicates a relaxed definition of "add"
! under {\tt multiflag=.false.} mode, where it is {\em not} an error if
! {\tt arrayList} contains items with names that are also found in
! {\tt arraybundle}. The {\tt arraybundle} is left unchanged for these items.
! For {\tt .false.} this is treated as an error condition.
! The default setting is {\tt .false.}.
! \item [{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOP
!------------------------------------------------------------------------------
integer :: localrc ! local return code
type(ESMF_Logical) :: multiflagArg
type(ESMF_Logical) :: relaxedflagArg
integer :: arrayCount, i
type(ESMF_Pointer), allocatable :: arrayPointerList(:)
! 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_SHORT(ESMF_ArrayBundleGetInit, arraybundle, rc)
! Determine the number of ArrayList elements
arrayCount = size(arrayList)
! Check init status of array arguments
do i=1, arrayCount
ESMF_INIT_CHECK_DEEP(ESMF_ArrayGetInit, arrayList(i), rc)
enddo
if (present(multiflag)) then
multiflagArg = multiflag
else
multiflagArg = ESMF_FALSE
endif
if (present(relaxedflag)) then
relaxedflagArg = relaxedflag
else
relaxedflagArg = ESMF_FALSE
endif
! Copy C++ pointers of deep objects into a simple ESMF_Pointer array
! This is necessary in order to strip off the F90 init check members
! when passing into C++
allocate(arrayPointerList(arrayCount))
do i=1, arrayCount
call ESMF_ArrayGetThis(arrayList(i), arrayPointerList(i), localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
enddo
! Call into the C++ interface layer
call c_ESMC_ArrayBundleAdd(arraybundle, arrayPointerList, arrayCount, &
multiflagArg, relaxedflagArg, localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! Garbage collection
deallocate(arrayPointerList)
! Return successfully
if (present(rc)) rc = ESMF_SUCCESS
end subroutine ESMF_ArrayBundleAdd