Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_ArrayBundle), | intent(inout) | :: | arraybundle | |||
character(len=*), | intent(in) | :: | arrayNameList(:) | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
logical, | intent(in), | optional | :: | multiflag | ||
logical, | intent(in), | optional | :: | relaxedflag | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_ArrayBundleRemove(arraybundle, arrayNameList, & keywordEnforcer, multiflag, relaxedflag, rc) ! ! !ARGUMENTS: type(ESMF_ArrayBundle), intent(inout) :: arraybundle character(len=*), intent(in) :: arrayNameList(:) 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: ! Remove Array(s) by name from ArrayBundle. In the relaxed setting it is ! {\em not} an error if {\tt arrayNameList} contains names that are not ! found in {\tt arraybundle}. ! ! \begin{description} ! \item [arraybundle] ! {\tt ESMF\_ArrayBundle} from which to remove items. ! \item [arrayNameList] ! List of items to remove. ! \item [{[multiflag]}] ! A setting of {\tt .true.} allows multiple Arrays with the same name ! to be removed from {\tt arraybundle}. For {\tt .false.}, items to be ! removed must have unique names. The default setting is {\tt .false.}. ! \item [{[relaxedflag]}] ! A setting of {\tt .true.} indicates a relaxed definition of "remove" ! where it is {\em not} an error if {\tt arrayNameList} contains item ! names that are not found in {\tt arraybundle}. For {\tt .false.} this is ! treated as an error condition. ! Further, in {\tt multiflag=.false.} mode, the relaxed definition of ! "remove" also covers the case where there are multiple items in ! {\tt arraybundle} that match a single entry in {\tt arrayNameList}. ! For {\tt relaxedflag=.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 :: itemCount ! 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) itemCount = size(arrayNameList) if (present(multiflag)) then multiflagArg = multiflag else multiflagArg = ESMF_FALSE endif if (present(relaxedflag)) then relaxedflagArg = relaxedflag else relaxedflagArg = ESMF_FALSE endif ! Call into the C++ interface layer call c_ESMC_ArrayBundleRemove(arraybundle, arrayNameList, itemCount, & multiflagArg, relaxedflagArg, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! Return successfully if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_ArrayBundleRemove