ESMF_StaggerLocEqual Function

private impure elemental function ESMF_StaggerLocEqual(StaggerLoc1, StaggerLoc2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_StaggerLoc), intent(in) :: StaggerLoc1
type(ESMF_StaggerLoc), intent(in) :: StaggerLoc2

Return Value logical


Called by

proc~~esmf_staggerlocequal~~CalledByGraph proc~esmf_staggerlocequal ESMF_StaggerLocEqual interface~operator (==)~2 operator (==) interface~operator (==)~2->proc~esmf_staggerlocequal

Source Code

      impure elemental function ESMF_StaggerLocEqual(StaggerLoc1, StaggerLoc2)

! !RETURN VALUE:
      logical :: ESMF_StaggerLocEqual

! !ARGUMENTS:

      type (ESMF_StaggerLoc), intent(in) :: &
         StaggerLoc1,      &! Two igrid statuses to compare for
         StaggerLoc2        ! equality

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

      ESMF_StaggerLocEqual = (StaggerLoc1%staggerloc == &
                              StaggerLoc2%staggerloc)

      end function ESMF_StaggerLocEqual