ESMF_PoleTypeEqual Function

private impure elemental function ESMF_PoleTypeEqual(PoleType1, PoleType2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_PoleKind_Flag), intent(in) :: PoleType1
type(ESMF_PoleKind_Flag), intent(in) :: PoleType2

Return Value logical


Called by

proc~~esmf_poletypeequal~~CalledByGraph proc~esmf_poletypeequal ESMF_PoleTypeEqual interface~operator (==)~12 operator (==) interface~operator (==)~12->proc~esmf_poletypeequal

Source Code

      impure elemental function ESMF_PoleTypeEqual(PoleType1, PoleType2)

! !RETURN VALUE:
      logical :: ESMF_PoleTypeEqual

! !ARGUMENTS:

      type (ESMF_PoleKind_Flag), intent(in) :: &
         PoleType1,      &! Two igrid statuses to compare for
         PoleType2        ! equality

! !DESCRIPTION:
!     This routine compares two ESMF PoleType statuses to see if
!     they are equivalent.
!
!     The arguments are:
!     \begin{description}
!     \item[PoleType1, PoleType2]
!          Two igrid statuses to compare for equality
!     \end{description}
!
!EOPI

      ESMF_PoleTypeEqual = (PoleType1%polekind == &
                              PoleType2%polekind)

      end function ESMF_PoleTypeEqual