ESMF_DynamicMaskGet Subroutine

public subroutine ESMF_DynamicMaskGet(dynamicMask, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_DynamicMask), intent(in) :: dynamicMask
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Source Code

  subroutine ESMF_DynamicMaskGet(dynamicMask, keywordEnforcer, rc)
!
! !ARGUMENTS:
    type(ESMF_DynamicMask), intent(in)            :: dynamicMask
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    integer,                       intent(out), optional :: rc
!
! !DESCRIPTION:
!   \label{api:DynamicMaskGet}
!   Get information from a {\tt ESMF\_DynamicMask} object.
!
!   The arguments are:
!   \begin{description}
!   \item[dynamicMask]
!     DynamicMask object.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer :: localrc      ! local return code
    integer :: localdimCount

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

    ! ensure dynamicMask is valid
    ESMF_INIT_CHECK_SHALLOW_SHORT(ESMF_DynamicMaskGetInit, dynamicMask, rc)

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

  end subroutine ESMF_DynamicMaskGet