ESMF_ArraySpecGet Subroutine

public subroutine ESMF_ArraySpecGet(arrayspec, keywordEnforcer, rank, typekind, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_ArraySpec), intent(in) :: arrayspec
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rank
type(ESMF_TypeKind_Flag), intent(out), optional :: typekind
integer, intent(out), optional :: rc

Calls

proc~~esmf_arrayspecget~~CallsGraph proc~esmf_arrayspecget ESMF_ArraySpecGet proc~esmf_arrayspecgetinit ESMF_ArraySpecGetInit proc~esmf_arrayspecget->proc~esmf_arrayspecgetinit proc~esmf_imerrs ESMF_IMErrS proc~esmf_arrayspecget->proc~esmf_imerrs proc~esmf_initcheckshallow ESMF_InitCheckShallow proc~esmf_imerrs->proc~esmf_initcheckshallow proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_imerrs->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

Called by

proc~~esmf_arrayspecget~~CalledByGraph proc~esmf_arrayspecget ESMF_ArraySpecGet proc~f_esmf_arrayspecget f_esmf_arrayspecget proc~f_esmf_arrayspecget->proc~esmf_arrayspecget proc~f_esmf_arrayspecgetrank f_esmf_arrayspecgetrank proc~f_esmf_arrayspecgetrank->proc~esmf_arrayspecget proc~f_esmf_arrayspecgettypekind f_esmf_arrayspecgettypekind proc~f_esmf_arrayspecgettypekind->proc~esmf_arrayspecget program~esmf_arrayspecex ESMF_ArraySpecEx program~esmf_arrayspecex->proc~esmf_arrayspecget program~esmf_arrayspecutest ESMF_ArraySpecUTest program~esmf_arrayspecutest->proc~esmf_arrayspecget

Source Code

  subroutine ESMF_ArraySpecGet(arrayspec, keywordEnforcer, rank, typekind, rc)
!
! !ARGUMENTS:
    type(ESMF_ArraySpec),     intent(in)            :: arrayspec
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,                  intent(out), optional :: rank
    type(ESMF_TypeKind_Flag), intent(out), optional :: typekind
    integer,                  intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
!   Returns information about the contents of an {\tt ESMF\_ArraySpec}.
!
!   The arguments are:
!   \begin{description}
!   \item[arrayspec]
!     The {\tt ESMF\_ArraySpec} to query.
!   \item[{[rank]}]
!     Array rank (dimensionality -- 1D, 2D, etc). Maximum possible is 7D.
!   \item[{[typekind]}]
!     Array typekind.  See section \ref{const:typekind} for valid values.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOP
!------------------------------------------------------------------------------
    ! initialize return code; assume routine not implemented
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
    ! Check init status of arguments
    ESMF_INIT_CHECK_SHALLOW(ESMF_ArraySpecGetInit, arrayspec, rc)

    ! Get arrayspec contents
    if(present(rank)) rank = arrayspec%rank
    if(present(typekind)) typekind = arrayspec%typekind

    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_ArraySpecGet