ESMF_IOAddArray Subroutine

public subroutine ESMF_IOAddArray(io, array, keywordEnforcer, variableName, convention, purpose, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_IO), intent(in) :: io
type(ESMF_Array), intent(in) :: array
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: variableName
character(len=*), intent(in), optional :: convention
character(len=*), intent(in), optional :: purpose
integer, intent(out), optional :: rc

Calls

proc~~esmf_ioaddarray~~CallsGraph proc~esmf_ioaddarray ESMF_IOAddArray c_esmc_ioaddarray c_esmc_ioaddarray proc~esmf_ioaddarray->c_esmc_ioaddarray proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_ioaddarray->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

Source Code

  subroutine ESMF_IOAddArray(io, array, keywordEnforcer,  &
                             variableName, convention, purpose, rc)

! !ARGUMENTS:
    type(ESMF_IO),           intent(in)            :: io
    type(ESMF_Array),        intent(in)            :: array
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    character(*),            intent(in),  optional :: variableName
    character(*),            intent(in),  optional :: convention
    character(*),            intent(in),  optional :: purpose
    integer,                 intent(out), optional :: rc
   
! !DESCRIPTION:
!     Gets one or more of the properties of an {\tt ESMF\_IO} object.
!
!     The arguments are:
!     \begin{description}
!     \item[io]
!          The {\tt ESMF\_IO} object instance to modify
!     \item[array]
!          The {\tt ESMF\_Array} object to add to io's element list
!     \item[{[variableName]}]
!          Optional variableName to attach to this array for I/O purposes
!     \item[{[convention]}]
!          Optional convention - AttPack for attribute and dimension names and values
!     \item[{[purpose]}]
!          Optional purpose - AttPack for attribute and dimension names and values
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI

    integer                     :: localrc     ! local return code
    integer                     :: len_varName ! name length or 0

    ! Assume failure until success
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    localrc = ESMF_RC_NOT_IMPL

    !   invoke C to C++ entry point
    if (present(variableName)) then
      len_varName = len_trim(variableName)
    else
      len_varName = 0
    endif

    call c_ESMC_IOAddArray(io, array,  &
        variableName, len_varName,     &
        convention, purpose,           &
        localrc)

    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
         ESMF_CONTEXT, rcToReturn=rc)) return
    
    ! Return success
    if (present(rc)) rc = ESMF_SUCCESS
  end subroutine ESMF_IOAddArray