source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/TRD/trdini.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 18 months ago

The Dr Hook changes from my perl code.

File size: 5.9 KB
Line 
1MODULE trdini
2   !!======================================================================
3   !!                       ***  MODULE  trdini  ***
4   !! Ocean diagnostics:  ocean tracers and dynamic trends
5   !!=====================================================================
6   !! History :   3.5  !  2012-02  (G. Madec) add 3D trends output for T, S, U, V, PE and KE
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   trd_init      : initialization step
11   !!----------------------------------------------------------------------
12   USE dom_oce        ! ocean domain
13   USE trd_oce        ! trends: ocean variables
14   USE trdken         ! trends: 3D kinetic   energy
15   USE trdpen         ! trends: 3D potential energy
16   USE trdglo         ! trends: global domain averaged tracers and dynamics
17   USE trdmxl         ! trends: mixed layer averaged trends (tracer only)
18   USE trdvor         ! trends: vertical averaged vorticity
19   USE in_out_manager ! I/O manager
20   USE lib_mpp        ! MPP library
21
22   USE yomhook, ONLY: lhook, dr_hook
23   USE parkind1, ONLY: jprb, jpim
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   trd_init   ! called by nemogcm.F90 module
29
30   !! * Substitutions
31#  include "domzgr_substitute.h90"
32#  include "vectopt_loop_substitute.h90"
33   !!----------------------------------------------------------------------
34   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
35   !! $Id$
36   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
37   !!----------------------------------------------------------------------
38CONTAINS
39
40   SUBROUTINE trd_init
41      !!----------------------------------------------------------------------
42      !!                  ***  ROUTINE trd_init  ***
43      !!
44      !! ** Purpose :   Initialization of trend diagnostics
45      !!----------------------------------------------------------------------
46      INTEGER ::   ios   ! local integer
47      !!
48      NAMELIST/namtrd/ ln_dyn_trd, ln_KE_trd, ln_vor_trd, ln_dyn_mxl,   &
49         &             ln_tra_trd, ln_PE_trd, ln_glo_trd, ln_tra_mxl, nn_trd 
50         INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
51         INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
52         REAL(KIND=jprb)               :: zhook_handle
53
54         CHARACTER(LEN=*), PARAMETER :: RoutineName='TRD_INIT'
55
56         IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
57
58      !!----------------------------------------------------------------------
59      !
60      REWIND( numnam_ref )              ! Namelist namtrd in reference namelist : trends diagnostic
61      READ  ( numnam_ref, namtrd, IOSTAT = ios, ERR = 901 )
62901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrd in reference namelist', lwp )
63      !
64      REWIND( numnam_cfg )              ! Namelist namtrd in configuration namelist : trends diagnostic
65      READ  ( numnam_cfg, namtrd, IOSTAT = ios, ERR = 902 )
66902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrd in configuration namelist', lwp )
67      IF(lwm) WRITE( numond, namtrd )
68      !
69      IF(lwp) THEN                  ! control print
70         WRITE(numout,*)
71         WRITE(numout,*) ' trd_init : Momentum/Tracers trends'
72         WRITE(numout,*) ' ~~~~~~~~~~'
73         WRITE(numout,*) '   Namelist namtrd : set trends parameters'
74         WRITE(numout,*) '      global domain averaged dyn & tra trends   ln_glo_trd  = ', ln_glo_trd
75         WRITE(numout,*) '      U & V trends: 3D output                   ln_dyn_trd  = ', ln_dyn_trd
76         WRITE(numout,*) '      U & V trends: Mixed Layer averaged        ln_dyn_mxl  = ', ln_dyn_mxl
77         WRITE(numout,*) '      T & S trends: 3D output                   ln_tra_trd  = ', ln_tra_trd
78         WRITE(numout,*) '      T & S trends: Mixed Layer averaged        ln_tra_mxl  = ', ln_tra_mxl
79         WRITE(numout,*) '      Kinetic   Energy trends                   ln_KE_trd   = ', ln_KE_trd
80         WRITE(numout,*) '      Potential Energy trends                   ln_PE_trd   = ', ln_PE_trd
81         WRITE(numout,*) '      Barotropic vorticity trends               ln_vor_trd  = ', ln_vor_trd
82         !
83         WRITE(numout,*) '      frequency of trends diagnostics (glo)     nn_trd      = ', nn_trd
84      ENDIF
85      !
86      !                             ! trend extraction flags 
87      l_trdtra = .FALSE.                                                       ! tracers 
88      IF ( ln_tra_trd .OR. ln_PE_trd .OR. ln_tra_mxl .OR.   &
89         & ln_glo_trd                                       )   l_trdtra = .TRUE. 
90      !
91      l_trddyn = .FALSE.                                                       ! momentum
92      IF ( ln_dyn_trd .OR. ln_KE_trd .OR. ln_dyn_mxl .OR.   &
93         & ln_vor_trd .OR. ln_glo_trd                       )   l_trddyn = .TRUE.
94      !
95
96!!gm check the stop below     
97      IF( ln_dyn_mxl )   CALL ctl_stop( 'ML diag on momentum are not yet coded we stop' )
98      !
99
100!!gm end
101      IF( ln_tra_mxl .OR. ln_vor_trd )   CALL ctl_stop( 'ML tracer and Barotropic vorticity diags are still using old IOIPSL' )
102!!gm end
103      !
104     
105!!gm  : Potential BUG : 3D output only for vector invariant form!  add a ctl_stop or code the flux form case
106!!gm  : bug/pb for vertical advection of tracer in vvl case: add T.dt[eta] in the output...
107
108      !                             ! diagnostic initialization 
109      IF( ln_glo_trd )   CALL trd_glo_init      ! global domain averaged trends
110      IF( ln_tra_mxl )   CALL trd_mxl_init      ! mixed-layer          trends 
111      IF( ln_vor_trd )   CALL trd_vor_init      ! barotropic vorticity trends
112      IF( ln_KE_trd  )   CALL trd_ken_init      ! 3D Kinetic    energy trends
113      IF( ln_PE_trd  )   CALL trd_pen_init      ! 3D Potential  energy trends
114      !
115         IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
116   END SUBROUTINE trd_init
117
118   !!======================================================================
119END MODULE trdini
Note: See TracBrowser for help on using the repository browser.