ESMF_CompIsDualConnected Function

public recursive function ESMF_CompIsDualConnected(compp, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CompClass), pointer :: compp
integer, intent(out), optional :: rc

Return Value logical


Calls

proc~~esmf_compisdualconnected~~CallsGraph proc~esmf_compisdualconnected ESMF_CompIsDualConnected proc~esmf_basegetstatus ESMF_BaseGetStatus proc~esmf_compisdualconnected->proc~esmf_basegetstatus proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compisdualconnected->proc~esmf_compclassgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_compisdualconnected->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_compisdualconnected->proc~esmf_logfounderror proc~esmf_logseterror ESMF_LogSetError proc~esmf_compisdualconnected->proc~esmf_logseterror proc~esmf_basegetstatus->proc~esmf_logfounderror c_esmc_basegetstatus c_esmc_basegetstatus proc~esmf_basegetstatus->c_esmc_basegetstatus 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 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_compisdualconnected~~CalledByGraph proc~esmf_compisdualconnected ESMF_CompIsDualConnected proc~esmf_cplcompdestroy ESMF_CplCompDestroy proc~esmf_cplcompdestroy->proc~esmf_compisdualconnected proc~esmf_cplcompfinalize ESMF_CplCompFinalize proc~esmf_cplcompfinalize->proc~esmf_compisdualconnected proc~esmf_cplcompinitialize ESMF_CplCompInitialize proc~esmf_cplcompinitialize->proc~esmf_compisdualconnected proc~esmf_cplcompreadrestart ESMF_CplCompReadRestart proc~esmf_cplcompreadrestart->proc~esmf_compisdualconnected proc~esmf_cplcomprun ESMF_CplCompRun proc~esmf_cplcomprun->proc~esmf_compisdualconnected proc~esmf_cplcompwait ESMF_CplCompWait proc~esmf_cplcompwait->proc~esmf_compisdualconnected proc~esmf_cplcompwriterestart ESMF_CplCompWriteRestart proc~esmf_cplcompwriterestart->proc~esmf_compisdualconnected proc~esmf_gridcompdestroy ESMF_GridCompDestroy proc~esmf_gridcompdestroy->proc~esmf_compisdualconnected proc~esmf_gridcompfinalize ESMF_GridCompFinalize proc~esmf_gridcompfinalize->proc~esmf_compisdualconnected proc~esmf_gridcompinitialize ESMF_GridCompInitialize proc~esmf_gridcompinitialize->proc~esmf_compisdualconnected proc~esmf_gridcompreadrestart ESMF_GridCompReadRestart proc~esmf_gridcompreadrestart->proc~esmf_compisdualconnected proc~esmf_gridcomprun ESMF_GridCompRun proc~esmf_gridcomprun->proc~esmf_compisdualconnected proc~esmf_gridcompwait ESMF_GridCompWait proc~esmf_gridcompwait->proc~esmf_compisdualconnected proc~esmf_gridcompwriterestart ESMF_GridCompWriteRestart proc~esmf_gridcompwriterestart->proc~esmf_compisdualconnected

Source Code

  recursive function ESMF_CompIsDualConnected(compp, rc)
!
! !RETURN VALUE:
    logical :: ESMF_CompIsDualConnected
!
! !ARGUMENTS:
    type(ESMF_CompClass), pointer               :: compp
    integer,              intent(out), optional :: rc             

!
! !DESCRIPTION:
!  Inquire if this component is a connected dual component.
!
!  The return value is {\tt .true.} if the component is a connected dual
!  component, {\tt .false.} otherwise.
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    type(ESMF_Status)       :: baseStatus

    ! Initialize return code; assume not implemented until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
        
    ! Initialize output in case of error
    ESMF_CompIsDualConnected = .false.

    ! 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)

    call ESMF_BaseGetStatus(compp%base, baseStatus, rc=localrc)
    if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
        
    if (baseStatus /= ESMF_STATUS_READY) then
      call ESMF_LogSetError(ESMF_RC_OBJ_BAD, &
        msg="uninitialized or destroyed Component object", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif
    
    ESMF_CompIsDualConnected = (compp%compTunnel%this /= ESMF_NULL_POINTER)
 
    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end function ESMF_CompIsDualConnected