source: NEMO/branches/2019/ENHANCE-02_ISF_nemo/src/OCE/ISF/isfutils.F90 @ 11987

Last change on this file since 11987 was 11987, checked in by mathiot, 10 months ago

ENHANCE-02_ISF_nemo: changes needed after Dave's review

File size: 4.0 KB
Line 
1MODULE isfutils
2   !!======================================================================
3   !!                       ***  MODULE  isfutils  ***
4   !! istutils module : miscelenious useful routines
5   !!======================================================================
6   !! History :  4.1  !  2019-09  (P. Mathiot) original code
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   isfutils       : - read_2dcstdta to read a constant input file with iom_get
11   !!                    - debug to print array sum, min, max in ocean.output
12   !!----------------------------------------------------------------------
13
14   USE iom           , ONLY: iom_open, iom_get, iom_close, jpdom_data ! read input file
15   USE lib_fortran   , ONLY: glob_sum, glob_min, glob_max             ! compute global value
16   USE par_oce       , ONLY: jpi,jpj,jpk                              ! domain size
17   USE in_out_manager, ONLY: wp, lwp, numout                          ! miscelenious
18
19   IMPLICIT NONE
20
21   PRIVATE
22
23   INTERFACE debug
24      MODULE PROCEDURE debug2d, debug3d
25   END INTERFACE debug
26
27   PUBLIC read_2dcstdta, debug
28
29CONTAINS
30
31   SUBROUTINE read_2dcstdta(cdfile, cdvar, pvar)
32      !!--------------------------------------------------------------------
33      !!                  ***  ROUTINE read_2dcstdta  ***
34      !!
35      !! ** Purpose : read input file
36      !!
37      !!-------------------------- OUT -------------------------------------
38      REAL(wp), DIMENSION(jpi,jpj), INTENT(  out) :: pvar          ! output variable
39      !!-------------------------- IN  -------------------------------------
40      CHARACTER(len=256)          , INTENT(in   ) :: cdfile   ! input file name
41      CHARACTER(len=34)           , INTENT(in   ) :: cdvar    ! variable name
42      !!--------------------------------------------------------------------
43      INTEGER :: inum
44      !!--------------------------------------------------------------------
45
46      CALL iom_open( TRIM(cdfile), inum )
47      CALL iom_get( inum, jpdom_data, TRIM(cdvar), pvar)
48      CALL iom_close(inum)
49
50   END SUBROUTINE read_2dcstdta
51
52   SUBROUTINE debug2d(cdtxt,pvar)
53      !!--------------------------------------------------------------------
54      !!                  ***  ROUTINE isf_debug2d  ***
55      !!
56      !! ** Purpose : add debug print for 2d variables
57      !!
58      !!-------------------------- IN  -------------------------------------
59      CHARACTER(LEN=256)          , INTENT(in   ) :: cdtxt
60      REAL(wp), DIMENSION(jpi,jpj), INTENT(in   ) :: pvar
61      !!--------------------------------------------------------------------
62      REAL(wp) :: zmin, zmax, zsum
63      !!--------------------------------------------------------------------
64      !
65      zsum = glob_sum( 'debug', pvar(:,:) )
66      zmin = glob_min( 'debug', pvar(:,:) )
67      zmax = glob_max( 'debug', pvar(:,:) )
68      !
69      IF (lwp) WRITE(numout,*) TRIM(cdtxt),' (min, max, sum) : ',zmin, zmax, zsum
70      !
71      CALL FLUSH(numout)
72      !
73   END SUBROUTINE debug2d
74
75   SUBROUTINE debug3d(cdtxt,pvar)
76      !!--------------------------------------------------------------------
77      !!                  ***  ROUTINE isf_debug3d  ***
78      !!
79      !! ** Purpose : add debug print for 3d variables
80      !!
81      !!-------------------------- IN  -------------------------------------
82      CHARACTER(LEN=256)              , INTENT(in   ) :: cdtxt
83      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in   ) :: pvar
84      !!--------------------------------------------------------------------
85      REAL(wp) :: zmin, zmax, zsum
86      !!--------------------------------------------------------------------
87      !
88      zsum = glob_sum( 'debug', pvar(:,:,:) )
89      zmin = glob_min( 'debug', pvar(:,:,:) )
90      zmax = glob_max( 'debug', pvar(:,:,:) )
91      !
92      IF (lwp) WRITE(numout,*) TRIM(cdtxt),' (min, max, sum) : ',zmin, zmax, zsum
93      !
94      CALL FLUSH(numout)
95      !
96   END SUBROUTINE debug3d
97
98END MODULE isfutils
99
Note: See TracBrowser for help on using the repository browser.