ESMF_GridDecompEqual Function

private impure elemental function ESMF_GridDecompEqual(GridDecomp1, GridDecomp2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridDecompType), intent(in) :: GridDecomp1
type(ESMF_GridDecompType), intent(in) :: GridDecomp2

Return Value logical


Source Code

      impure elemental function ESMF_GridDecompEqual(GridDecomp1, GridDecomp2)

! !RETURN VALUE:
      logical :: ESMF_GridDecompEqual

! !ARGUMENTS:

      type (ESMF_GridDecompType), intent(in) :: &
         GridDecomp1,      &! Two igrid statuses to compare for
         GridDecomp2        ! equality

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

      ESMF_GridDecompEqual = (GridDecomp1%griddecomptype == &
                              GridDecomp2%griddecomptype)

      end function ESMF_GridDecompEqual