ESMF_CompSetVMStdRedirect Subroutine

public subroutine ESMF_CompSetVMStdRedirect(compp, stdout, stderr, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CompClass), pointer :: compp
character(len=*), intent(in), optional :: stdout
character(len=*), intent(in), optional :: stderr
integer, intent(out), optional :: rc

Calls

proc~~esmf_compsetvmstdredirect~~CallsGraph proc~esmf_compsetvmstdredirect ESMF_CompSetVMStdRedirect proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compsetvmstdredirect->proc~esmf_compclassgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_compsetvmstdredirect->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_compsetvmstdredirect->proc~esmf_logfounderror proc~esmf_logseterror ESMF_LogSetError proc~esmf_compsetvmstdredirect->proc~esmf_logseterror proc~esmf_vmplansetstdredirect ESMF_VMPlanSetStdRedirect proc~esmf_compsetvmstdredirect->proc~esmf_vmplansetstdredirect 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 proc~esmf_logseterror->esmf_breakpoint proc~esmf_logseterror->proc~esmf_logrc2msg proc~esmf_logseterror->proc~esmf_logwrite proc~esmf_vmplansetstdredirect->proc~esmf_imerr proc~esmf_vmplansetstdredirect->proc~esmf_logfounderror c_esmc_vmplansetstderr c_esmc_vmplansetstderr proc~esmf_vmplansetstdredirect->c_esmc_vmplansetstderr c_esmc_vmplansetstdout c_esmc_vmplansetstdout proc~esmf_vmplansetstdredirect->c_esmc_vmplansetstdout proc~esmf_vmplangetinit ESMF_VMPlanGetInit proc~esmf_vmplansetstdredirect->proc~esmf_vmplangetinit 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_compsetvmstdredirect~~CalledByGraph proc~esmf_compsetvmstdredirect ESMF_CompSetVMStdRedirect proc~esmf_cplcompsetvmstdredirect ESMF_CplCompSetVMStdRedirect proc~esmf_cplcompsetvmstdredirect->proc~esmf_compsetvmstdredirect proc~esmf_gridcompsetvmstdredirect ESMF_GridCompSetVMStdRedirect proc~esmf_gridcompsetvmstdredirect->proc~esmf_compsetvmstdredirect proc~mygcomp_setvm mygcomp_setvm proc~mygcomp_setvm->proc~esmf_gridcompsetvmstdredirect proc~mygcomp_setvmforcepthreads mygcomp_setvmForcePthreads proc~mygcomp_setvmforcepthreads->proc~esmf_gridcompsetvmstdredirect proc~nuopc_setvm NUOPC_SetVM proc~nuopc_setvm->proc~esmf_gridcompsetvmstdredirect program~esmf_vmcomponentutest ESMF_VMComponentUTest program~esmf_vmcomponentutest->proc~esmf_gridcompsetvmstdredirect

Source Code

  subroutine ESMF_CompSetVMStdRedirect(compp, stdout, stderr, rc)
!
! !ARGUMENTS:
    type(ESMF_CompClass), pointer               :: compp
    character(*),         intent(in),  optional :: stdout
    character(*),         intent(in),  optional :: stderr
    integer,              intent(out), optional :: rc
!
! !DESCRIPTION:
!     Configure VM for this component.
!
!     The arguments are:
!     \begin{description}
!     \item[compp]
!          component object
!     \item[{[stdout]}]
!          Filename for the stdout redirect. By default do not redirect.
!     \item[{[stderr]}]
!          Filename for the stderr redirect. By default do not redirect.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! Initialize return code; assume not implemented until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! Test incoming compp object
    if (.not.associated(compp)) then
      call ESMF_LogSetError(ESMF_RC_OBJ_BAD, &
        msg="Not a valid pointer to ESMF Component object", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_CompClassGetInit, compp, rc)

    ! ensure that this is not a child_in_parent_vm plan
    if (compp%contextflag == ESMF_CONTEXT_PARENT_VM) then
      call ESMF_LogSetError(ESMF_RC_NOT_VALID, &
        msg="CompSetVM() calls are incompatible with CHILD_IN_PARENT_VM component", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif
    
    ! ensure that this component's VM wasn't already created
    if (compp%vm_info /= ESMF_NULL_POINTER) then
      call ESMF_LogSetError(ESMF_RC_NOT_VALID, &
        msg="CompSetVM() calls cannot be called on components with existing VM", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif

    ! set stdout and stderr redirect
    call ESMF_VMPlanSetStdRedirect(compp%vmplan, stdout=stdout, stderr=stderr, &
      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_CompSetVMStdRedirect