ESMF_SciCompGet Subroutine

public subroutine ESMF_SciCompGet(scicomp, keywordEnforcer, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_SciComp), intent(in) :: scicomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: rc

Calls

proc~~esmf_scicompget~~CallsGraph proc~esmf_scicompget ESMF_SciCompGet proc~esmf_compget ESMF_CompGet proc~esmf_scicompget->proc~esmf_compget proc~esmf_compstatusget ESMF_CompStatusGet proc~esmf_scicompget->proc~esmf_compstatusget proc~esmf_imerr ESMF_IMErr proc~esmf_scicompget->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_scicompget->proc~esmf_logfounderror proc~esmf_scicompgetinit ESMF_SciCompGetInit proc~esmf_scicompget->proc~esmf_scicompgetinit proc~esmf_compget->proc~esmf_imerr proc~esmf_compget->proc~esmf_logfounderror c_esmc_compget c_esmc_compget proc~esmf_compget->c_esmc_compget interface~esmf_vmget ESMF_VMGet proc~esmf_compget->interface~esmf_vmget proc~esmf_basegetstatus ESMF_BaseGetStatus proc~esmf_compget->proc~esmf_basegetstatus proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compget->proc~esmf_compclassgetinit proc~esmf_configget ESMF_ConfigGet proc~esmf_compget->proc~esmf_configget proc~esmf_getname ESMF_GetName proc~esmf_compget->proc~esmf_getname proc~esmf_logfoundallocerror ESMF_LogFoundAllocError proc~esmf_compget->proc~esmf_logfoundallocerror proc~esmf_logseterror ESMF_LogSetError proc~esmf_compget->proc~esmf_logseterror proc~esmf_compstatusgetinit ESMF_CompStatusGetInit proc~esmf_compstatusget->proc~esmf_compstatusgetinit proc~esmf_imerrs ESMF_IMErrS proc~esmf_compstatusget->proc~esmf_imerrs 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

Called by

proc~~esmf_scicompget~~CalledByGraph proc~esmf_scicompget ESMF_SciCompGet proc~esmf_namedaliasscicomp ESMF_NamedAliasSciComp proc~esmf_namedaliasscicomp->proc~esmf_scicompget proc~f_esmf_scicompget f_esmf_scicompget proc~f_esmf_scicompget->proc~esmf_scicompget proc~testscicompnamedalias TestSciCompNamedAlias proc~testscicompnamedalias->proc~esmf_scicompget proc~updatewithscicomp ESMF_InfoDescribe%updateWithSciComp proc~updatewithscicomp->proc~esmf_scicompget interface~esmf_namedalias ESMF_NamedAlias interface~esmf_namedalias->proc~esmf_namedaliasscicomp none~update ESMF_InfoDescribe%Update none~update->proc~updatewithscicomp program~esmf_namedaliasutest ESMF_NamedAliasUTest program~esmf_namedaliasutest->proc~testscicompnamedalias

Source Code

  subroutine ESMF_SciCompGet(scicomp, keywordEnforcer, name, rc)
!
! !ARGUMENTS:
    type(ESMF_SciComp),       intent(in)            :: scicomp
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    character(len=*),         intent(out), optional :: name
    integer,                  intent(out), optional :: rc
!
! !DESCRIPTION:
! Get information about an {\tt ESMF\_SciComp} object.
!  
! The arguments are:
! \begin{description}
! \item[scicomp]
!   The {\tt ESMF\_SciComp} object being queried.
! \item[{[name]}]
!   Return the name of the {\tt ESMF\_SciComp}.
! \item[{[rc]}]
!   Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer               :: localrc      ! local return code
    type(ESMF_CompStatus) :: compStatus

    ! initialize return code; assume routine not implemented
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    localrc = ESMF_RC_NOT_IMPL

    ESMF_INIT_CHECK_DEEP(ESMF_SciCompGetInit,scicomp,localrc)

    ! call Comp method
    call ESMF_CompGet(scicomp%compp, name=name, compStatus=compStatus, &
       rc=localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=localrc)) return

    if (scicomp%isNamedAlias .and. present(name)) then
      ! access NamedAlias name
      name = trim(scicomp%name)
    endif

    ! call Comp method
    call ESMF_CompStatusGet(compStatus, rc = localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=localrc)) return

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS
  end subroutine ESMF_SciCompGet