Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_ArrayBundle), | intent(inout) | :: | arraybundle | |||
type(ESMF_RouteHandle), | intent(inout) | :: | routehandle | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
logical, | intent(in), | optional | :: | checkflag | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_ArrayBundleHalo(arraybundle, routehandle, keywordEnforcer, & checkflag, rc) ! ! !ARGUMENTS: type(ESMF_ArrayBundle), intent(inout) :: arraybundle type(ESMF_RouteHandle), intent(inout) :: routehandle type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below logical, intent(in), optional :: checkflag integer, intent(out), optional :: rc ! ! !STATUS: ! \begin{itemize} ! \item\apiStatusCompatibleVersion{5.2.0r} ! \end{itemize} ! ! !DESCRIPTION: ! Execute a precomputed ArrayBundle halo operation for the Arrays in ! {\tt arrayBundle}. ! ! See {\tt ESMF\_ArrayBundleHaloStore()} on how to precompute ! {\tt routehandle}. ! ! This call is {\em collective} across the current VM. ! ! \begin{description} ! \item [arraybundle] ! {\tt ESMF\_ArrayBundle} containing data to be haloed. ! \item [routehandle] ! Handle to the precomputed Route. ! \item [{[checkflag]}] ! If set to {\tt .TRUE.} the input Array pairs will be checked for ! consistency with the precomputed operation provided by {\tt routehandle}. ! If set to {\tt .FALSE.} {\em (default)} only a very basic input check ! will be performed, leaving many inconsistencies undetected. Set ! {\tt checkflag} to {\tt .FALSE.} to achieve highest performance. ! \item [{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOP !------------------------------------------------------------------------------ integer :: localrc ! local return code type(ESMF_Logical) :: opt_checkflag! 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, deal with optional ArrayBundle args ESMF_INIT_CHECK_DEEP_SHORT(ESMF_RouteHandleGetInit, routehandle, rc) ESMF_INIT_CHECK_DEEP_SHORT(ESMF_ArrayBundleGetInit, arraybundle, rc) ! Set default flags opt_checkflag = ESMF_FALSE if (present(checkflag)) opt_checkflag = checkflag ! Call into the C++ interface, which will sort out optional arguments call c_ESMC_ArrayBundleHalo(arraybundle, routehandle, opt_checkflag, & localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! return successfully if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_ArrayBundleHalo