ESMF_XGridGeomTypeEqual Function

private impure elemental function ESMF_XGridGeomTypeEqual(GeomType1, GeomType2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_XGridGeomType_Flag), intent(in) :: GeomType1
type(ESMF_XGridGeomType_Flag), intent(in) :: GeomType2

Return Value logical


Source Code

      impure elemental function ESMF_XGridGeomTypeEqual(GeomType1, GeomType2)

! !RETURN VALUE:
      logical :: ESMF_XGridGeomTypeEqual

! !ARGUMENTS:

      type (ESMF_XGridGeomType_Flag), intent(in) :: &
         GeomType1,      &! Two igrid statuses to compare for
         GeomType2        ! equality

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

      ESMF_XGridGeomTypeEqual = (GeomType1%type == &
                              GeomType2%type)

      end function ESMF_XGridGeomTypeEqual