ESMF_XGridSideEqual Function

private impure elemental function ESMF_XGridSideEqual(XGridSide1, XGridSide2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_XGridSide_Flag), intent(in) :: XGridSide1
type(ESMF_XGridSide_Flag), intent(in) :: XGridSide2

Return Value logical


Called by

proc~~esmf_xgridsideequal~~CalledByGraph proc~esmf_xgridsideequal ESMF_XGridSideEqual interface~operator (==)~14 operator (==) interface~operator (==)~14->proc~esmf_xgridsideequal

Source Code

      impure elemental function ESMF_XGridSideEqual(XGridSide1, XGridSide2)

! !RETURN VALUE:
      logical :: ESMF_XGridSideEqual

! !ARGUMENTS:

      type (ESMF_XGridSide_Flag), intent(in) :: &
        XGridSide1,      &! Two xgrid sides to compare for
        XGridSide2        ! equality

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

      ESMF_XGridSideEqual = (XGridSide1%side == &
                              XGridSide2%side)

      end function ESMF_XGridSideEqual