New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
trcsms_medusa.F90 in branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/TOP_SRC/MEDUSA – NEMO

source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/TOP_SRC/MEDUSA/trcsms_medusa.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 5 years ago

The Dr Hook changes from my perl code.
File size: 5.8 KB
Line 
1MODULE trcsms_medusa
2   !!======================================================================
3   !!                         ***  MODULE trcsms_medusa  ***
4   !! TOP :   Main module of the MEDUSA tracers
5   !!======================================================================
6   !! History :   2.0  !  2007-12  (C. Ethe, G. Madec) Original code
7   !!              -   !  2008-08  (K. Popova) adaptation for MEDUSA
8   !!              -   !  2008-11  (A. Yool) continuing adaptation for MEDUSA
9   !!              -   !  2010-03  (A. Yool) updated for branch inclusion
10   !!              -   !  2017-02  (A. Yool, J. Palmieri) move dust call
11   !!              -   !  2017-08  (A. Yool) amend for slow detritus bug
12   !!----------------------------------------------------------------------
13#if defined key_medusa
14   !!----------------------------------------------------------------------
15   !!   'key_medusa'                                       bio tracers
16   !!----------------------------------------------------------------------
17   !! trc_sms_medusa   : MEDUSA_TRC model main routine
18   !!----------------------------------------------------------------------
19   USE par_trc         ! TOP parameters
20   USE oce_trc
21   USE trc
22   USE trcbio_medusa
23   USE trcopt_medusa
24   USE trcsed_medusa
25   USE trcavg_medusa
26   !! for SMS trends
27   USE par_medusa,    ONLY: jp_msa0, jp_msa1, jp_medusa
28   USE par_oce,       ONLY: jpi, jpj, jpk
29   USE trd_oce,       ONLY: jptra_sms, l_trdtrc
30   USE trdtrc
31
32
33   USE yomhook, ONLY: lhook, dr_hook
34   USE parkind1, ONLY: jprb, jpim
35
36   IMPLICIT NONE
37   PRIVATE
38
39   PUBLIC   trc_sms_medusa   ! called by trcsms.F90 module
40
41   !!----------------------------------------------------------------------
42   !! NEMO/TOP 2.0 , LOCEAN-IPSL (2007)
43   !! $Id$
44   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
45   !!----------------------------------------------------------------------
46
47CONTAINS
48
49   SUBROUTINE trc_sms_medusa( kt )
50      !!----------------------------------------------------------------------
51      !!                     ***  trc_sms_medusa  *** 
52      !!
53      !! ** Purpose :   main routine of MEDUSA_TRC model
54      !!
55      !! ** Method  : -
56      !!----------------------------------------------------------------------
57      INTEGER, INTENT(in) :: kt   ! ocean time-step index
58      !! Loop variables
59      INTEGER :: jn
60      !! trend temporary array:
61      REAL(wp), POINTER, DIMENSION(:,:,:,:) :: ztrmed
62      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
63      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
64      REAL(KIND=jprb)               :: zhook_handle
65
66      CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_SMS_MEDUSA'
67
68      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
69
70
71
72# if defined key_debug_medusa
73         IF(lwp) WRITE(numout,*) ' MEDUSA inside trc_sms_medusa'
74         CALL flush(numout)
75# endif
76
77      IF( kt == nittrc000 ) THEN
78       IF(lwp) WRITE(numout,*)
79       IF(lwp) WRITE(numout,*) ' trc_sms_medusa:  MEDUSA model'
80       IF(lwp) WRITE(numout,*) ' ~~~~~~~~~~~~~~'
81      ENDIF
82
83      !! MEDUSA SMS trends:
84      IF( l_trdtrc ) THEN
85          CALL wrk_alloc( jpi, jpj, jpk, jp_medusa, ztrmed )
86          ztrmed(:,:,:,:)=0.0 
87          DO jn = 1, jp_medusa
88            ztrmed(:,:,:,jn) = tra(:,:,:,jp_msa0 + jn - 1)
89          END DO
90      END IF
91
92      CALL trc_avg_medusa( kt ) ! rolling average module
93# if defined key_debug_medusa
94      IF(lwp) WRITE(numout,*) ' MEDUSA done trc_avg_medusa'
95      CALL flush(numout)
96# endif
97     
98      CALL trc_opt_medusa( kt ) ! optical model
99# if defined key_debug_medusa
100      IF(lwp) WRITE(numout,*) ' MEDUSA done trc_opt_medusa'
101      CALL flush(numout)
102# endif
103
104      !! AXY & JPALM (28/02/17): call dust before trc_bio_medusa (because of coupling)
105      CALL trc_sed_medusa_dust( kt ) ! dust submodel
106# if defined key_debug_medusa
107      IF(lwp) WRITE(numout,*) ' MEDUSA done trc_sed_medusa_dust'
108      CALL flush(numout)
109# endif
110
111# if defined key_kill_medusa
112      !! MEDUSA skipped
113      IF(lwp) WRITE(numout,*) ' MEDUSA killed at kt =', kt
114      CALL flush(numout)
115# else
116      CALL trc_bio_medusa( kt ) ! biological model
117#  if defined key_debug_medusa
118      IF(lwp) WRITE(numout,*) ' MEDUSA done trc_bio_medusa'
119      CALL flush(numout)
120#  endif
121     
122!! AXY (08/08/2017): remove call to buggy subroutine (now handled by detritus.F90)
123!!       CALL trc_sed_medusa( kt ) ! sedimentation model
124!! #  if defined key_debug_medusa
125!!       IF(lwp) WRITE(numout,*) ' MEDUSA done trc_sed_medusa'
126!!       CALL flush(numout)
127!! #  endif
128# endif
129
130      !! MEDUSA SMS trends:
131      IF( l_trdtrc ) THEN
132          DO jn = 1, jp_medusa
133            ztrmed(:,:,:,jn) = tra(:,:,:,jp_msa0 + jn - 1)-ztrmed(:,:,:,jn)
134            CALL trd_trc( ztrmed(:,:,:,jn), jn, jptra_sms, kt )   ! save trends
135          END DO
136          CALL wrk_dealloc( jpi, jpj, jpk, jp_medusa, ztrmed )
137      END IF
138
139
140      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
141   END SUBROUTINE trc_sms_medusa
142   
143#else
144   !!----------------------------------------------------------------------
145   !!   Dummy module                                        No MEDUSA model
146   !!----------------------------------------------------------------------
147CONTAINS
148   SUBROUTINE trc_sms_medusa( kt )             ! Empty routine
149      INTEGER, INTENT( in ) ::   kt
150      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
151      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
152      REAL(KIND=jprb)               :: zhook_handle
153
154      CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_SMS_MEDUSA'
155
156      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
157
158      WRITE(*,*) 'trc_sms_medusa: You should not have seen this print! error?', kt
159      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
160   END SUBROUTINE trc_sms_medusa
161#endif
162
163   !!======================================================================
164END MODULE trcsms_medusa
165
Note: See TracBrowser for help on using the repository browser.