ESMF_GridMatchEqual Function

private impure elemental function ESMF_GridMatchEqual(GridMatch1, GridMatch2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridMatch_Flag), intent(in) :: GridMatch1
type(ESMF_GridMatch_Flag), intent(in) :: GridMatch2

Return Value logical


Source Code

      impure elemental function ESMF_GridMatchEqual(GridMatch1, GridMatch2)

! !RETURN VALUE:
      logical :: ESMF_GridMatchEqual

! !ARGUMENTS:

      type (ESMF_GridMatch_Flag), intent(in) :: &
         GridMatch1,      &! Two igrid statuses to compare for
         GridMatch2        ! equality

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

      ESMF_GridMatchEqual = (GridMatch1%gridmatch == &
                              GridMatch2%gridmatch)

      end function ESMF_GridMatchEqual