deallocate_if_associated_mod.F90

Go to the documentation of this file.

MODULE deallocate_if_associated_mod

!**** DEALLOCATE_IF_ASSOCIATED_MOD

!     Purpose.
!     --------
!     The pattern "IF (ASSOCIATED(<pointer>)) DEALLOCATE(>pointer>)"
!     occurs all over the IFS. With this module, we can just do
!     "CALL DEALLOCATE_IF_ASSOCIATED(<pointer>)".

!**   Interface.
!     ----------

!        CALL DEALLOCATE_IF_ASSOCIATED(P)

!        Input required arguments :
!        -------------------------
!           P        -  A pointer to an array

!     Author.
!     -------
!        Mike Fisher  ECMWF

!     Modifications.
!     --------------
!        Original: 2012-03-01

!     ------------------------------------------------------------------

USE parkind1  ,ONLY : jpim     ,jprb
USE yomhook   ,ONLY : lhook,   dr_hook

SAVE
PRIVATE
PUBLIC  deallocate_if_associated

INTERFACE deallocate_if_associated
  MODULE PROCEDURE deallocate_if_associated_real_1d, &
                 & deallocate_if_associated_real_2d, &
                 & deallocate_if_associated_real_3d, &
                 & deallocate_if_associated_real_4d, &
                 & deallocate_if_associated_real_5d, &
                 & deallocate_if_associated_integer_1d, &
                 & deallocate_if_associated_integer_2d, &
                 & deallocate_if_associated_integer_3d, &
                 & deallocate_if_associated_logical_1d, &
                 & deallocate_if_associated_logical_2d
END INTERFACE

!     ------------------------------------------------------------------

CONTAINS

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_real_1d (ZOBJ)
  IMPLICIT NONE
  REAL(KIND=JPRB), DIMENSION(:), POINTER :: ZOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_1D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(zobj)) DEALLOCATE(zobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_1D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_real_1d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_real_2d (ZOBJ)
  IMPLICIT NONE
  REAL(KIND=JPRB), DIMENSION(:,:), POINTER :: ZOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_2D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(zobj)) DEALLOCATE(zobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_2D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_real_2d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_real_3d (ZOBJ)
  IMPLICIT NONE
  REAL(KIND=JPRB), DIMENSION(:,:,:), POINTER :: ZOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_3D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(zobj)) DEALLOCATE(zobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_3D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_real_3d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_real_4d (ZOBJ)
  IMPLICIT NONE
  REAL(KIND=JPRB), DIMENSION(:,:,:,:), POINTER :: ZOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_4D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(zobj)) DEALLOCATE(zobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_4D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_real_4d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_real_5d (ZOBJ)
  IMPLICIT NONE
  REAL(KIND=JPRB), DIMENSION(:,:,:,:,:), POINTER :: ZOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_5D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(zobj)) DEALLOCATE(zobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_REAL_5D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_real_5d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_integer_1d (KOBJ)
  IMPLICIT NONE
  INTEGER(KIND=JPIM), DIMENSION(:), POINTER :: KOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_INTEGER_1D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(kobj)) DEALLOCATE(kobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_INTEGER_1D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_integer_1d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_integer_2d (KOBJ)
  IMPLICIT NONE
  INTEGER(KIND=JPIM), DIMENSION(:,:), POINTER :: KOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_INTEGER_2D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(kobj)) DEALLOCATE(kobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_INTEGER_2D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_integer_2d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_integer_3d (KOBJ)
  IMPLICIT NONE
  INTEGER(KIND=JPIM), DIMENSION(:,:,:), POINTER :: KOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_INTEGER_3D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(kobj)) DEALLOCATE(kobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_INTEGER_3D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_integer_3d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_logical_1d (LDOBJ)
  IMPLICIT NONE
  LOGICAL, DIMENSION(:), POINTER :: LDOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_LOGICAL_1D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(ldobj)) DEALLOCATE(ldobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_LOGICAL_1D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_logical_1d

!     ------------------------------------------------------------------

SUBROUTINE deallocate_if_associated_logical_2d (LDOBJ)
  IMPLICIT NONE
  LOGICAL, DIMENSION(:,:), POINTER :: LDOBJ
  REAL(KIND=JPRB) :: ZHOOK_HANDLE

  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_LOGICAL_2D', &
                         & 0,zhook_handle)
  IF (ASSOCIATED(ldobj)) DEALLOCATE(ldobj)
  IF (lhook) CALL dr_hook ('DEALLOCATE_IF_ASSOCIATED_MOD:DEALLOCATE_IF_ASSOCIATED_LOGICAL_2D', &
                         & 1,zhook_handle)
END SUBROUTINE deallocate_if_associated_logical_2d

!     ------------------------------------------------------------------

END MODULE deallocate_if_associated_mod