ESMF_SetPersist Subroutine

public subroutine ESMF_SetPersist(base, persist, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Base), intent(in) :: base
logical, intent(in) :: persist
integer, intent(out), optional :: rc

Source Code

  subroutine ESMF_SetPersist(base, persist, rc) 
!
! !RETURN VALUE:
!    none
!
! !ARGUMENTS:
    type(ESMF_Base), intent(in)  :: base
    logical,         intent(in)  :: persist 
    integer,         intent(out) , optional :: rc
!
! !DESCRIPTION:
!      Set persist flag
!
!     The arguments are:
!     \begin{description}
!     \item [{[base]}]
!           Base object.
!     \item [{[persist]}]
!           Value of to set the persist flag.
!     \item [{[rc]}]
!           Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
    integer             :: localrc
    type(ESMF_Logical)  :: persistFlag

    ! Initialize
    localrc = ESMF_RC_NOT_IMPL
    rc = ESMF_RC_NOT_IMPL

    persistFlag = persist ! convert logical -> ESMF_Logical

    call c_ESMC_SetPersist(base, persistFlag, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! Return successfully
    rc = ESMF_SUCCESS

  end subroutine ESMF_SetPersist