ESMF_FieldRedist Subroutine

public subroutine ESMF_FieldRedist(srcField, dstField, routehandle, keywordEnforcer, checkflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in), optional :: srcField
type(ESMF_Field), intent(inout), optional :: dstField
type(ESMF_RouteHandle), intent(inout) :: routehandle
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
logical, intent(in), optional :: checkflag
integer, intent(out), optional :: rc

Calls

proc~~esmf_fieldredist~~CallsGraph proc~esmf_fieldredist ESMF_FieldRedist esmf_arraysetthisnull esmf_arraysetthisnull proc~esmf_fieldredist->esmf_arraysetthisnull esmf_fieldget esmf_fieldget proc~esmf_fieldredist->esmf_fieldget proc~esmf_arrayredist ESMF_ArrayRedist proc~esmf_fieldredist->proc~esmf_arrayredist proc~esmf_fieldgetinit ESMF_FieldGetInit proc~esmf_fieldredist->proc~esmf_fieldgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_fieldredist->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_fieldredist->proc~esmf_logfounderror proc~esmf_routehandlegetinit ESMF_RouteHandleGetInit proc~esmf_fieldredist->proc~esmf_routehandlegetinit proc~esmf_arrayredist->esmf_arraysetthisnull proc~esmf_arrayredist->proc~esmf_imerr proc~esmf_arrayredist->proc~esmf_logfounderror proc~esmf_arrayredist->proc~esmf_routehandlegetinit c_esmc_arrayredist c_esmc_arrayredist proc~esmf_arrayredist->c_esmc_arrayredist esmf_arraygetinit esmf_arraygetinit proc~esmf_arrayredist->esmf_arraygetinit esmf_arraygetthis esmf_arraygetthis proc~esmf_arrayredist->esmf_arraygetthis proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_fieldredist~~CalledByGraph proc~esmf_fieldredist ESMF_FieldRedist proc~field_redist_test field_redist_test proc~field_redist_test->proc~esmf_fieldredist proc~user_run~21 user_run proc~user_run~21->proc~esmf_fieldredist proc~user_run~45 user_run proc~user_run~45->proc~esmf_fieldredist proc~user_run~74 user_run proc~user_run~74->proc~esmf_fieldredist proc~user_run~87 user_run proc~user_run~87->proc~esmf_fieldredist proc~user_run~93 user_run proc~user_run~93->proc~esmf_fieldredist program~arb2arbfldredist Arb2ArbFldReDist program~arb2arbfldredist->proc~esmf_fieldredist program~blk2arbfldredist Blk2ArbFldRedist program~blk2arbfldredist->proc~esmf_fieldredist program~blk2blkfldredist Blk2BlkFldRedist program~blk2blkfldredist->proc~esmf_fieldredist program~esmf_fieldredistarbutest ESMF_FieldRedistArbUTest program~esmf_fieldredistarbutest->proc~esmf_fieldredist program~esmf_rhandlefromfileex ESMF_RHandleFromFileEx program~esmf_rhandlefromfileex->proc~esmf_fieldredist program~esmf_rhandlefromrhandleex ESMF_RHandleFromRHandleEx program~esmf_rhandlefromrhandleex->proc~esmf_fieldredist program~esmf_routehandleadvancedutest ESMF_RouteHandleAdvancedUTest program~esmf_routehandleadvancedutest->proc~esmf_fieldredist program~esmf_routehandleutest ESMF_RouteHandleUTest program~esmf_routehandleutest->proc~esmf_fieldredist program~fieldredist FieldRedist program~fieldredist->proc~esmf_fieldredist program~fieldredistex FieldRedistEx program~fieldredistex->proc~esmf_fieldredist proc~runtests RunTests proc~runtests->proc~field_redist_test program~esmf_test_harness esmf_test_harness program~esmf_test_harness->proc~runtests

Source Code

  subroutine ESMF_FieldRedist(srcField, dstField, routehandle, keywordEnforcer,  &
    checkflag, rc)
!
! !ARGUMENTS:
        type(ESMF_Field),       intent(in),optional     :: srcField
        type(ESMF_Field),       intent(inout),optional  :: dstField
        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 Field redistribution from {\tt srcField} to
!   {\tt dstField}. 
!   Both {\tt srcField} and {\tt dstField} must match the respective Fields
!   used during {\tt ESMF\_FieldRedistStore()} in {\em type}, {\em kind}, and 
!   memory layout of the {\em gridded} dimensions. However, the size, number, 
!   and index order of {\em ungridded} dimensions may be different. See section
!   \ref{RH:Reusability} for a more detailed discussion of RouteHandle 
!   reusability.
!
!   The {\tt srcField} and {\tt dstField} arguments are optional in support of
!   the situation where {\tt srcField} and/or {\tt dstField} are not defined on
!   all PETs. The {\tt srcField} and {\tt dstField} must be specified on those
!   PETs that hold source or destination DEs, respectively, but may be omitted
!   on all other PETs. PETs that hold neither source nor destination DEs may
!   omit both arguments.
!
!   It is erroneous to specify the identical Field object for {\tt srcField} and
!   {\tt dstField} arguments.
!
!   See {\tt ESMF\_FieldRedistStore()} on how to precompute 
!   {\tt routehandle}.
!
!   This call is {\em collective} across the current VM.
!
!   For examples and associated documentation regarding this method see Section
!   \ref{sec:field:usage:redist_1dptr}. 
!
!   \begin{description}
!   \item [{[srcField]}]
!     {\tt ESMF\_Field} with source data.
!   \item [{[dstField]}]
!     {\tt ESMF\_Field} with destination data.
!   \item [routehandle]
!     Handle to the precomputed Route.
!   \item [{[checkflag]}]
!     If set to {\tt .TRUE.} the input Field pair 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
        
        ! local variables to buffer optional arguments
        type(ESMF_Array)        :: l_srcArray ! helper variable
        type(ESMF_Array)        :: l_dstArray ! 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 Field args
        ESMF_INIT_CHECK_DEEP(ESMF_RouteHandleGetInit, routehandle, rc)
        ESMF_INIT_CHECK_DEEP(ESMF_FieldGetInit, srcField, rc)
        ESMF_INIT_CHECK_DEEP(ESMF_FieldGetInit, dstField, rc)

        if (present(srcField)) then
          call ESMF_FieldGet(srcField, array=l_srcArray, rc=localrc)
          if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return
        else
          call ESMF_ArraySetThisNull(l_srcArray, localrc)
          if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return
        endif

        if (present(dstField)) then
          call ESMF_FieldGet(dstField, array=l_dstArray, rc=localrc)
          if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return
        else
          call ESMF_ArraySetThisNull(l_dstArray, localrc)
          if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return
        endif
        
        ! perform Field redist through internal array
        call ESMF_ArrayRedist(srcArray=l_srcArray, dstArray=l_dstArray, &
          routehandle=routehandle, checkflag=checkflag, 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_FieldRedist