ESMF_ArraySetPLocalDe Subroutine

private subroutine ESMF_ArraySetPLocalDe(array, keywordEnforcer, localDe, rimSeqIndex, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Array), intent(inout) :: array
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in) :: localDe
integer, intent(in), optional :: rimSeqIndex(:)
integer, intent(out), optional :: rc

Calls

proc~~esmf_arraysetplocalde~~CallsGraph proc~esmf_arraysetplocalde ESMF_ArraySetPLocalDe esmf_arraysetplocaldeinternal esmf_arraysetplocaldeinternal proc~esmf_arraysetplocalde->esmf_arraysetplocaldeinternal proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_arraysetplocalde->proc~esmf_logfounderror 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_arraysetplocalde~~CalledByGraph proc~esmf_arraysetplocalde ESMF_ArraySetPLocalDe interface~esmf_arrayset ESMF_ArraySet interface~esmf_arrayset->proc~esmf_arraysetplocalde proc~testarraynamedalias TestArrayNamedAlias proc~testarraynamedalias->interface~esmf_arrayset proc~user_init~13 user_init proc~user_init~13->interface~esmf_arrayset proc~user_init~15 user_init proc~user_init~15->interface~esmf_arrayset proc~user_init~20 user_init proc~user_init~20->interface~esmf_arrayset proc~user_init~25 user_init proc~user_init~25->interface~esmf_arrayset proc~user_init~26 user_init proc~user_init~26->interface~esmf_arrayset proc~user_init~32 user_init proc~user_init~32->interface~esmf_arrayset proc~user_init~39 user_init proc~user_init~39->interface~esmf_arrayset proc~user_init~41 user_init proc~user_init~41->interface~esmf_arrayset proc~user_init~44 user_init proc~user_init~44->interface~esmf_arrayset proc~user_init~5 user_init proc~user_init~5->interface~esmf_arrayset proc~user_init~50 user_init proc~user_init~50->interface~esmf_arrayset proc~user_init~58 user_init proc~user_init~58->interface~esmf_arrayset proc~user_init~78 user_init proc~user_init~78->interface~esmf_arrayset proc~user_init~79 user_init proc~user_init~79->interface~esmf_arrayset proc~user_init~82 user_init proc~user_init~82->interface~esmf_arrayset proc~x_comp_grid_diag x_comp_grid_diag proc~x_comp_grid_diag->interface~esmf_arrayset program~esmf_arraycreategetutest ESMF_ArrayCreateGetUTest program~esmf_arraycreategetutest->interface~esmf_arrayset proc~realize Realize proc~realize->proc~x_comp_grid_diag program~esmf_namedaliasutest ESMF_NamedAliasUTest program~esmf_namedaliasutest->proc~testarraynamedalias

Source Code

  subroutine ESMF_ArraySetPLocalDe(array, keywordEnforcer, localDe, rimSeqIndex, rc)

!
! !ARGUMENTS:
    type(ESMF_Array),   intent(inout)         :: array
    integer,            intent(in)            :: localDe
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,            intent(in),  optional :: rimSeqIndex(:)
    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 for a specific
!     localDe.
!
!     The arguments are:
!     \begin{description}
!     \item [array]
!       {\tt ESMF\_Array} object for which to set properties.
!     \item [localDe]
!       Local DE for which to set values.
!     \item[{[rimSeqIndex]}] 
!       Sequence indices in the halo rim of localDe.
!     \item [{[rc]}]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
    ! Call into the internal method
    call ESMF_ArraySetPLocalDeInternal(array, localDe, rimSeqIndex, 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_ArraySetPLocalDe