yomhook.F90

Go to the documentation of this file.

MODULE yomhook

USE parkind1  ,ONLY : jpim, jprb, jprm, jprd

IMPLICIT NONE

! Used by "hook" function
! LHOOK = true implies "hook" function will be called
! Altough initialized to TRUE it will be reset by first call to 
! DR_HOOK unless we really want to use the hook function

SAVE
PUBLIC

LOGICAL :: lhook=.true.

#include "dr_hook_util.h"
#include "dr_hook_util_multi.h"

INTERFACE dr_hook  
! We want compile time mapping of DR_HOOK-arguments and not
! to test OPTIONAL-arguments with PRESENT()-function, since
! it costs more.
! However, this "unrolling" approach cannot be streched much more
! than this without making number of member-functions too large
! (i.e. all the possible permutations of these "optional" args;
!  arguments that are not present in the DR_HOOK_DEFAULT -version)

MODULE PROCEDURE &
  dr_hook_default4, &
  dr_hook_default8, &
  dr_hook_file, &
  dr_hook_size, &
  dr_hook_file_size, &
  dr_hook_multi_default, &
  dr_hook_multi_file, &
  dr_hook_multi_size, &
  dr_hook_multi_file_size
END INTERFACE

CONTAINS 

SUBROUTINE dr_hook_default4(CDNAME,KSWITCH,PKEY)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH
REAL(KIND=JPRM),        INTENT(INOUT) :: PKEY
REAL(KIND=JPRB) :: ZKEY
zkey = transfer(pkey,zkey)
CALL dr_hook_util(lhook,cdname,kswitch,zkey,'',0_jpim)
pkey = transfer(zkey,pkey)
END SUBROUTINE dr_hook_default4

SUBROUTINE dr_hook_default8(CDNAME,KSWITCH,PKEY)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH
REAL(KIND=JPRD),        INTENT(INOUT) :: PKEY
REAL(KIND=JPRB) :: ZKEY
zkey = transfer(pkey,zkey)
CALL dr_hook_util(lhook,cdname,kswitch,zkey,'',0_jpim)
pkey = transfer(zkey,pkey)
END SUBROUTINE dr_hook_default8



SUBROUTINE dr_hook_multi_default(CDNAME,KSWITCH,PKEY)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY(:)
CALL dr_hook_util_multi(lhook,cdname,kswitch,pkey,int(SIZE(pkey)),'',0_jpim)
END SUBROUTINE dr_hook_multi_default



SUBROUTINE dr_hook_file(CDNAME,KSWITCH,PKEY,CDFILE)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME,CDFILE
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY
CALL dr_hook_util(lhook,cdname,kswitch,pkey,cdfile,0_jpim)
END SUBROUTINE dr_hook_file

SUBROUTINE dr_hook_multi_file(CDNAME,KSWITCH,PKEY,CDFILE)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME,CDFILE
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY(:)
CALL dr_hook_util_multi(lhook,cdname,kswitch,pkey,int(SIZE(pkey)),cdfile,0_jpim)
END SUBROUTINE dr_hook_multi_file



SUBROUTINE dr_hook_size(CDNAME,KSWITCH,PKEY,KSIZEINFO)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH,KSIZEINFO
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY
CALL dr_hook_util(lhook,cdname,kswitch,pkey,'',ksizeinfo)
END SUBROUTINE dr_hook_size

SUBROUTINE dr_hook_multi_size(CDNAME,KSWITCH,PKEY,KSIZEINFO)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH,KSIZEINFO
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY(:)
CALL dr_hook_util_multi(lhook,cdname,kswitch,pkey,int(SIZE(pkey)),'',ksizeinfo)
END SUBROUTINE dr_hook_multi_size



SUBROUTINE dr_hook_file_size(CDNAME,KSWITCH,PKEY,CDFILE,KSIZEINFO)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME,CDFILE
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH,KSIZEINFO
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY
CALL dr_hook_util(lhook,cdname,kswitch,pkey,cdfile,ksizeinfo)
END SUBROUTINE dr_hook_file_size

SUBROUTINE dr_hook_multi_file_size(CDNAME,KSWITCH,PKEY,CDFILE,KSIZEINFO)
CHARACTER(LEN=*), INTENT(IN) :: CDNAME,CDFILE
INTEGER(KIND=JPIM),        INTENT(IN) :: KSWITCH,KSIZEINFO
REAL(KIND=JPRB),        INTENT(INOUT) :: PKEY(:)
CALL dr_hook_util_multi(lhook,cdname,kswitch,pkey,int(SIZE(pkey)),cdfile,ksizeinfo)
END SUBROUTINE dr_hook_multi_file_size

END MODULE yomhook