source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/TOP/TRP/trcrad.F90 @ 11483

Last change on this file since 11483 was 11483, checked in by davestorkey, 2 years ago

2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : Update more header comments and change logs.
Also remove debugging output from trcstp.F90 and correct bug in step_c1d.F90. Note C1D untested in this branch.

  • Property svn:keywords set to Id
File size: 12.4 KB
Line 
1MODULE trcrad
2   !!======================================================================
3   !!                       ***  MODULE  trcrad  ***
4   !! Ocean passive tracers:  correction of negative concentrations
5   !!======================================================================
6   !! History :   -   !  01-01  (O. Aumont & E. Kestenare)  Original code
7   !!            1.0  !  04-03  (C. Ethe)  free form F90
8   !!            4.1  !  08-19  (A. Coward, D. Storkey) tidy up using new time-level indices
9   !!----------------------------------------------------------------------
10#if defined key_top
11   !!----------------------------------------------------------------------
12   !!   'key_top'                                                TOP models
13   !!----------------------------------------------------------------------
14   !!   trc_rad    : correction of negative concentrations
15   !!----------------------------------------------------------------------
16   USE par_trc             ! need jptra, number of passive tracers
17   USE oce_trc             ! ocean dynamics and tracers variables
18   USE trc                 ! ocean passive tracers variables
19   USE trd_oce
20   USE trdtra
21   USE prtctl_trc          ! Print control for debbuging
22   USE lib_fortran
23
24   IMPLICIT NONE
25   PRIVATE
26
27   PUBLIC trc_rad     
28   PUBLIC trc_rad_ini 
29
30   LOGICAL , PUBLIC ::   ln_trcrad           !: flag to artificially correct negative concentrations
31   REAL(wp), DIMENSION(:,:), ALLOCATABLE::   gainmass
32
33   !!----------------------------------------------------------------------
34   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
35   !! $Id$
36   !! Software governed by the CeCILL license (see ./LICENSE)
37   !!----------------------------------------------------------------------
38CONTAINS
39
40   SUBROUTINE trc_rad( kt, Kbb, Kmm, ptr )
41      !!----------------------------------------------------------------------
42      !!                  ***  ROUTINE trc_rad  ***
43      !!
44      !! ** Purpose :   "crappy" routine to correct artificial negative
45      !!              concentrations due to isopycnal scheme
46      !!
47      !! ** Method  : - PISCES or LOBSTER: Set negative concentrations to zero
48      !!                while computing the corresponding tracer content that
49      !!                is added to the tracers. Then, adjust the tracer
50      !!                concentration using a multiplicative factor so that
51      !!                the total tracer concentration is preserved.
52      !!              - CFC: simply set to zero the negative CFC concentration
53      !!                (the total CFC content is not strictly preserved)
54      !!----------------------------------------------------------------------
55      INTEGER,                                    INTENT(in   ) :: kt         ! ocean time-step index
56      INTEGER,                                    INTENT(in   ) :: Kbb, Kmm   ! time level indices
57      REAL(wp), DIMENSION(jpi,jpj,jpk,jptra,jpt), INTENT(inout) :: ptr        ! passive tracers and RHS of tracer equation
58      !
59      CHARACTER (len=22) :: charout
60      !!----------------------------------------------------------------------
61      !
62      IF( ln_timing )   CALL timing_start('trc_rad')
63      !
64      IF( ln_age     )   CALL trc_rad_sms( kt, Kbb, Kmm, ptr, jp_age , jp_age                )  !  AGE
65      IF( ll_cfc     )   CALL trc_rad_sms( kt, Kbb, Kmm, ptr, jp_cfc0, jp_cfc1               )  !  CFC model
66      IF( ln_c14     )   CALL trc_rad_sms( kt, Kbb, Kmm, ptr, jp_c14 , jp_c14                )  !  C14
67      IF( ln_pisces  )   CALL trc_rad_sms( kt, Kbb, Kmm, ptr, jp_pcs0, jp_pcs1, cpreserv='Y' )  !  PISCES model
68      IF( ln_my_trc  )   CALL trc_rad_sms( kt, Kbb, Kmm, ptr, jp_myt0, jp_myt1               )  !  MY_TRC model
69      !
70      IF(ln_ctl) THEN      ! print mean trends (used for debugging)
71         WRITE(charout, FMT="('rad')")
72         CALL prt_ctl_trc_info( charout )
73         CALL prt_ctl_trc( tab4d=ptr(:,:,:,:,Kbb), mask=tmask, clinfo=ctrcnm )
74      ENDIF
75      !
76      IF( ln_timing )   CALL timing_stop('trc_rad')
77      !
78   END SUBROUTINE trc_rad
79
80
81   SUBROUTINE trc_rad_ini
82      !!---------------------------------------------------------------------
83      !!                  ***  ROUTINE trc _rad_ini ***
84      !!
85      !! ** Purpose :   read  namelist options
86      !!----------------------------------------------------------------------
87      INTEGER ::   ios   ! Local integer output status for namelist read
88      !!
89      NAMELIST/namtrc_rad/ ln_trcrad
90      !!----------------------------------------------------------------------
91      !
92      REWIND( numnat_ref )              ! namtrc_rad in reference namelist
93      READ  ( numnat_ref, namtrc_rad, IOSTAT = ios, ERR = 907)
94907   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtrc_rad in reference namelist', lwp )
95      REWIND( numnat_cfg )              ! namtrc_rad in configuration namelist
96      READ  ( numnat_cfg, namtrc_rad, IOSTAT = ios, ERR = 908 )
97908   IF( ios > 0 )   CALL ctl_nam ( ios , 'namtrc_rad in configuration namelist', lwp )
98      IF(lwm) WRITE( numont, namtrc_rad )
99
100      IF(lwp) THEN                     !   ! Control print
101         WRITE(numout,*)
102         WRITE(numout,*) 'trc_rad : Correct artificial negative concentrations '
103         WRITE(numout,*) '~~~~~~~ '
104         WRITE(numout,*) '   Namelist namtrc_rad : treatment of negative concentrations'
105         WRITE(numout,*) '      correct artificially negative concen. or not   ln_trcrad = ', ln_trcrad
106         WRITE(numout,*)
107         IF( ln_trcrad ) THEN   ;   WRITE(numout,*) '      ===>>   ensure the global tracer conservation'
108         ELSE                   ;   WRITE(numout,*) '      ===>>   NO strict global tracer conservation'     
109         ENDIF
110      ENDIF
111      !
112      ALLOCATE( gainmass(jptra,2) )
113      gainmass(:,:) = 0.
114      !
115   END SUBROUTINE trc_rad_ini
116
117
118   SUBROUTINE trc_rad_sms( kt, Kbb, Kmm, ptr, jp_sms0, jp_sms1, cpreserv )
119     !!-----------------------------------------------------------------------------
120     !!                  ***  ROUTINE trc_rad_sms  ***
121     !!
122     !! ** Purpose :   "crappy" routine to correct artificial negative
123     !!              concentrations due to isopycnal scheme
124     !!
125     !! ** Method  : 2 cases :
126     !!                - Set negative concentrations to zero while computing
127     !!                  the corresponding tracer content that is added to the
128     !!                  tracers. Then, adjust the tracer concentration using
129     !!                  a multiplicative factor so that the total tracer
130     !!                  concentration is preserved.
131     !!                - simply set to zero the negative CFC concentration
132     !!                  (the total content of concentration is not strictly preserved)
133     !!--------------------------------------------------------------------------------
134     INTEGER                                    , INTENT(in   ) ::   kt                 ! ocean time-step index
135     INTEGER                                    , INTENT(in   ) ::   Kbb, Kmm           ! time level indices
136     INTEGER                                    , INTENT(in   ) ::   jp_sms0, jp_sms1   ! First & last index of the passive tracer model
137     REAL(wp), DIMENSION (jpi,jpj,jpk,jptra,jpt), INTENT(inout) ::   ptr                ! before and now traceur concentration
138     CHARACTER( len = 1), OPTIONAL              , INTENT(in   ) ::   cpreserv           ! flag to preserve content or not
139     !
140     INTEGER ::   ji, ji2, jj, jj2, jk, jn, jt ! dummy loop indices
141     INTEGER ::   icnt, itime
142     LOGICAL ::   lldebug = .FALSE.            ! local logical
143     REAL(wp)::   zcoef, zs2rdt, ztotmass
144     REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   ztrneg, ztrpos
145     REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   ztrtrd   ! workspace arrays
146     !!----------------------------------------------------------------------
147     !
148     IF( l_trdtrc )   ALLOCATE( ztrtrd(jpi,jpj,jpk) )
149     zs2rdt = 1. / ( 2. * rdt * REAL( nn_dttrc, wp ) )
150     !
151     DO jt = 1,2  ! Loop over time indices since exactly the same fix is applied to "now" and "after" fields
152        IF( jt == 1 ) itime = Kbb
153        IF( jt == 2 ) itime = Kmm
154
155        IF( PRESENT( cpreserv )  ) THEN     !==  total tracer concentration is preserved  ==!
156           !
157           ALLOCATE( ztrneg(1:jpi,1:jpj,jp_sms0:jp_sms1), ztrpos(1:jpi,1:jpj,jp_sms0:jp_sms1) )
158
159           DO jn = jp_sms0, jp_sms1
160              ztrneg(:,:,jn) = SUM( MIN( 0., ptr(:,:,:,jn,itime) ) * cvol(:,:,:), dim = 3 )   ! sum of the negative values
161              ztrpos(:,:,jn) = SUM( MAX( 0., ptr(:,:,:,jn,itime) ) * cvol(:,:,:), dim = 3 )   ! sum of the positive values
162           END DO
163           CALL sum3x3( ztrneg )
164           CALL sum3x3( ztrpos )
165
166           DO jn = jp_sms0, jp_sms1
167              !
168              IF( l_trdtrc )   ztrtrd(:,:,:) = ptr(:,:,:,jn,itime)                       ! save input tr(:,:,:,:,Kbb) for trend computation           
169              !
170              DO jk = 1, jpkm1
171                 DO jj = 1, jpj
172                    DO ji = 1, jpi
173                       IF( ztrneg(ji,jj,jn) /= 0. ) THEN                                 ! if negative values over the 3x3 box
174                          !
175                          ptr(ji,jj,jk,jn,itime) = ptr(ji,jj,jk,jn,itime) * tmask(ji,jj,jk)   ! really needed?
176                          IF( ptr(ji,jj,jk,jn,itime) < 0. ) ptr(ji,jj,jk,jn,itime) = 0.       ! suppress negative values
177                          IF( ptr(ji,jj,jk,jn,itime) > 0. ) THEN                    ! use positive values to compensate mass gain
178                             zcoef = 1. + ztrneg(ji,jj,jn) / ztrpos(ji,jj,jn)       ! ztrpos > 0 as ptr > 0
179                             ptr(ji,jj,jk,jn,itime) = ptr(ji,jj,jk,jn,itime) * zcoef
180                             IF( zcoef < 0. ) THEN                                  ! if the compensation exceed the positive value
181                                gainmass(jn,1) = gainmass(jn,1) - ptr(ji,jj,jk,jn,itime) * cvol(ji,jj,jk)   ! we are adding mass...
182                                ptr(ji,jj,jk,jn,itime) = 0.                         ! limit the compensation to keep positive value
183                             ENDIF
184                          ENDIF
185                          !
186                       ENDIF
187                    END DO
188                 END DO
189              END DO
190              !
191              IF( l_trdtrc ) THEN
192                 ztrtrd(:,:,:) = ( ptr(:,:,:,jn,itime) - ztrtrd(:,:,:) ) * zs2rdt
193                 CALL trd_tra( kt, Kbb, Kmm, 'TRC', jn, jptra_radb, ztrtrd )       ! Asselin-like trend handling
194              ENDIF
195              !
196           END DO
197
198           IF( kt == nitend ) THEN
199              CALL mpp_sum( 'trcrad', gainmass(:,1) )
200              DO jn = jp_sms0, jp_sms1
201                 IF( gainmass(jn,1) > 0. ) THEN
202                    ztotmass = glob_sum( 'trcrad', ptr(:,:,:,jn,itime) * cvol(:,:,:) )
203                    IF(lwp) WRITE(numout, '(a, i2, a, D23.16, a, D23.16)') 'trcrad ptrb, traceur ', jn  &
204                         &        , ' total mass : ', ztotmass, ', mass gain : ',  gainmass(jn,1)
205                 END IF
206              END DO
207           ENDIF
208
209           DEALLOCATE( ztrneg, ztrpos )
210           !
211        ELSE                                !==  total CFC content is NOT strictly preserved  ==!
212           !
213           DO jn = jp_sms0, jp_sms1 
214              !
215              IF( l_trdtrc )   ztrtrd(:,:,:) = ptr(:,:,:,jn,itime)                 ! save input tr for trend computation
216              !
217              WHERE( ptr(:,:,:,jn,itime) < 0. )   ptr(:,:,:,jn,itime) = 0.
218              !
219              IF( l_trdtrc ) THEN
220                 ztrtrd(:,:,:) = ( ptr(:,:,:,jn,itime) - ztrtrd(:,:,:) ) * zs2rdt
221                 CALL trd_tra( kt, Kbb, Kmm, 'TRC', jn, jptra_radb, ztrtrd )       ! Asselin-like trend handling
222              ENDIF
223              !
224           END DO
225           !
226        ENDIF
227        !
228      END DO
229      !
230      IF( l_trdtrc )  DEALLOCATE( ztrtrd )
231      !
232   END SUBROUTINE trc_rad_sms
233
234#else
235   !!----------------------------------------------------------------------
236   !!   Dummy module :                                         NO TOP model
237   !!----------------------------------------------------------------------
238CONTAINS
239   SUBROUTINE trc_rad( kt, Kbb, Kmm )              ! Empty routine
240      INTEGER, INTENT(in) ::   kt
241      INTEGER, INTENT(in) ::   Kbb, Kmm  ! time level indices
242      WRITE(*,*) 'trc_rad: You should not have seen this print! error?', kt
243   END SUBROUTINE trc_rad
244#endif
245   
246   !!======================================================================
247END MODULE trcrad
Note: See TracBrowser for help on using the repository browser.