source: NEMO/trunk/src/TOP/TRP/trcrad.F90 @ 10376

Last change on this file since 10376 was 10068, checked in by nicolasmartin, 2 years ago

First part of modifications to have a common default header : fix typos and SVN keywords properties

  • Property svn:keywords set to Id
File size: 11.1 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   !!----------------------------------------------------------------------
9#if defined key_top
10   !!----------------------------------------------------------------------
11   !!   'key_top'                                                TOP models
12   !!----------------------------------------------------------------------
13   !!   trc_rad    : correction of negative concentrations
14   !!----------------------------------------------------------------------
15   USE par_trc             ! need jptra, number of passive tracers
16   USE oce_trc             ! ocean dynamics and tracers variables
17   USE trc                 ! ocean passive tracers variables
18   USE trd_oce
19   USE trdtra
20   USE prtctl_trc          ! Print control for debbuging
21
22   IMPLICIT NONE
23   PRIVATE
24
25   PUBLIC trc_rad     
26   PUBLIC trc_rad_ini 
27
28   LOGICAL , PUBLIC ::   ln_trcrad           !: flag to artificially correct negative concentrations
29
30   !!----------------------------------------------------------------------
31   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
32   !! $Id$
33   !! Software governed by the CeCILL license (see ./LICENSE)
34   !!----------------------------------------------------------------------
35CONTAINS
36
37   SUBROUTINE trc_rad( kt )
38      !!----------------------------------------------------------------------
39      !!                  ***  ROUTINE trc_rad  ***
40      !!
41      !! ** Purpose :   "crappy" routine to correct artificial negative
42      !!              concentrations due to isopycnal scheme
43      !!
44      !! ** Method  : - PISCES or LOBSTER: Set negative concentrations to zero
45      !!                while computing the corresponding tracer content that
46      !!                is added to the tracers. Then, adjust the tracer
47      !!                concentration using a multiplicative factor so that
48      !!                the total tracer concentration is preserved.
49      !!              - CFC: simply set to zero the negative CFC concentration
50      !!                (the total CFC content is not strictly preserved)
51      !!----------------------------------------------------------------------
52      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
53      !
54      CHARACTER (len=22) :: charout
55      !!----------------------------------------------------------------------
56      !
57      IF( ln_timing )   CALL timing_start('trc_rad')
58      !
59      IF( ln_age     )   CALL trc_rad_sms( kt, trb, trn, jp_age , jp_age                )  !  AGE
60      IF( ll_cfc     )   CALL trc_rad_sms( kt, trb, trn, jp_cfc0, jp_cfc1               )  !  CFC model
61      IF( ln_c14     )   CALL trc_rad_sms( kt, trb, trn, jp_c14 , jp_c14                )  !  C14
62      IF( ln_pisces  )   CALL trc_rad_sms( kt, trb, trn, jp_pcs0, jp_pcs1, cpreserv='Y' )  !  PISCES model
63      IF( ln_my_trc  )   CALL trc_rad_sms( kt, trb, trn, jp_myt0, jp_myt1               )  !  MY_TRC model
64      !
65      IF(ln_ctl) THEN      ! print mean trends (used for debugging)
66         WRITE(charout, FMT="('rad')")
67         CALL prt_ctl_trc_info( charout )
68         CALL prt_ctl_trc( tab4d=trn, mask=tmask, clinfo=ctrcnm )
69      ENDIF
70      !
71      IF( ln_timing )   CALL timing_stop('trc_rad')
72      !
73   END SUBROUTINE trc_rad
74
75
76   SUBROUTINE trc_rad_ini
77      !!---------------------------------------------------------------------
78      !!                  ***  ROUTINE trc _rad_ini ***
79      !!
80      !! ** Purpose :   read  namelist options
81      !!----------------------------------------------------------------------
82      INTEGER ::   ios   ! Local integer output status for namelist read
83      !!
84      NAMELIST/namtrc_rad/ ln_trcrad
85      !!----------------------------------------------------------------------
86      !
87      REWIND( numnat_ref )              ! namtrc_rad in reference namelist
88      READ  ( numnat_ref, namtrc_rad, IOSTAT = ios, ERR = 907)
89907   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtrc_rad in reference namelist', lwp )
90      REWIND( numnat_cfg )              ! namtrc_rad in configuration namelist
91      READ  ( numnat_cfg, namtrc_rad, IOSTAT = ios, ERR = 908 )
92908   IF( ios > 0 )   CALL ctl_nam ( ios , 'namtrc_rad in configuration namelist', lwp )
93      IF(lwm) WRITE( numont, namtrc_rad )
94
95      IF(lwp) THEN                     !   ! Control print
96         WRITE(numout,*)
97         WRITE(numout,*) 'trc_rad : Correct artificial negative concentrations '
98         WRITE(numout,*) '~~~~~~~ '
99         WRITE(numout,*) '   Namelist namtrc_rad : treatment of negative concentrations'
100         WRITE(numout,*) '      correct artificially negative concen. or not   ln_trcrad = ', ln_trcrad
101         WRITE(numout,*)
102         IF( ln_trcrad ) THEN   ;   WRITE(numout,*) '      ===>>   ensure the global tracer conservation'
103         ELSE                   ;   WRITE(numout,*) '      ===>>   NO strict global tracer conservation'     
104         ENDIF
105      ENDIF
106      !
107   END SUBROUTINE trc_rad_ini
108
109
110   SUBROUTINE trc_rad_sms( kt, ptrb, ptrn, jp_sms0, jp_sms1, cpreserv )
111      !!-----------------------------------------------------------------------------
112      !!                  ***  ROUTINE trc_rad_sms  ***
113      !!
114      !! ** Purpose :   "crappy" routine to correct artificial negative
115      !!              concentrations due to isopycnal scheme
116      !!
117      !! ** Method  : 2 cases :
118      !!                - Set negative concentrations to zero while computing
119      !!                  the corresponding tracer content that is added to the
120      !!                  tracers. Then, adjust the tracer concentration using
121      !!                  a multiplicative factor so that the total tracer
122      !!                  concentration is preserved.
123      !!                - simply set to zero the negative CFC concentration
124      !!                  (the total content of concentration is not strictly preserved)
125      !!--------------------------------------------------------------------------------
126      INTEGER                                , INTENT(in   ) ::   kt                 ! ocean time-step index
127      INTEGER                                , INTENT(in   ) ::   jp_sms0, jp_sms1   ! First & last index of the passive tracer model
128      REAL(wp), DIMENSION (jpi,jpj,jpk,jptra), INTENT(inout) ::   ptrb    , ptrn     ! before and now traceur concentration
129      CHARACTER( len = 1), OPTIONAL          , INTENT(in   ) ::   cpreserv           ! flag to preserve content or not
130      !
131      INTEGER ::   ji, jj, jk, jn     ! dummy loop indices
132      LOGICAL ::   lldebug = .FALSE.           ! local logical
133      REAL(wp)::   ztrcorb, ztrmasb, zs2rdt    ! temporary scalars
134      REAL(wp)::   zcoef  , ztrcorn, ztrmasn   !    -         -
135      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   ztrtrdb, ztrtrdn   ! workspace arrays
136      !!----------------------------------------------------------------------
137      !
138      IF( l_trdtrc )   ALLOCATE( ztrtrdb(jpi,jpj,jpk), ztrtrdn(jpi,jpj,jpk) )
139      !
140      IF( PRESENT( cpreserv )  ) THEN     !==  total tracer concentration is preserved  ==!
141         !
142         DO jn = jp_sms0, jp_sms1
143            !
144            ztrcorb = 0._wp   ;   ztrmasb = 0._wp
145            ztrcorn = 0._wp   ;   ztrmasn = 0._wp
146            !
147            IF( l_trdtrc ) THEN
148               ztrtrdb(:,:,:) = ptrb(:,:,:,jn)                        ! save input trb for trend computation
149               ztrtrdn(:,:,:) = ptrn(:,:,:,jn)                        ! save input trn for trend computation
150            ENDIF
151            !                                                         ! sum over the global domain
152            ztrcorb = glob_sum( MIN( 0., ptrb(:,:,:,jn) ) * cvol(:,:,:) )
153            ztrcorn = glob_sum( MIN( 0., ptrn(:,:,:,jn) ) * cvol(:,:,:) )
154            !
155            ztrmasb = glob_sum( MAX( 0., ptrb(:,:,:,jn) ) * cvol(:,:,:) )
156            ztrmasn = glob_sum( MAX( 0., ptrn(:,:,:,jn) ) * cvol(:,:,:) )
157            !
158            IF( ztrcorb /= 0 ) THEN
159               zcoef = 1. + ztrcorb / ztrmasb
160               DO jk = 1, jpkm1
161                  ptrb(:,:,jk,jn) = MAX( 0., ptrb(:,:,jk,jn) )
162                  ptrb(:,:,jk,jn) = ptrb(:,:,jk,jn) * zcoef * tmask(:,:,jk)
163               END DO
164            ENDIF
165            !
166            IF( ztrcorn /= 0 ) THEN
167               zcoef = 1. + ztrcorn / ztrmasn
168               DO jk = 1, jpkm1
169                  ptrn(:,:,jk,jn) = MAX( 0., ptrn(:,:,jk,jn) )
170                  ptrn(:,:,jk,jn) = ptrn(:,:,jk,jn) * zcoef * tmask(:,:,jk)
171               END DO
172            ENDIF
173            !
174            IF( l_trdtrc ) THEN
175               !
176               zs2rdt = 1. / ( 2. * rdt )
177               ztrtrdb(:,:,:) = ( ptrb(:,:,:,jn) - ztrtrdb(:,:,:) ) * zs2rdt
178               ztrtrdn(:,:,:) = ( ptrn(:,:,:,jn) - ztrtrdn(:,:,:) ) * zs2rdt 
179               CALL trd_tra( kt, 'TRC', jn, jptra_radb, ztrtrdb )       ! Asselin-like trend handling
180               CALL trd_tra( kt, 'TRC', jn, jptra_radn, ztrtrdn )       ! standard     trend handling
181              !
182            ENDIF
183            !
184         END DO
185         !
186      ELSE                                !==  total CFC content is NOT strictly preserved  ==!
187         !
188         DO jn = jp_sms0, jp_sms1 
189            !
190            IF( l_trdtrc ) THEN
191               ztrtrdb(:,:,:) = ptrb(:,:,:,jn)                        ! save input trb for trend computation
192               ztrtrdn(:,:,:) = ptrn(:,:,:,jn)                        ! save input trn for trend computation
193            ENDIF
194            !
195            DO jk = 1, jpkm1
196               DO jj = 1, jpj
197                  DO ji = 1, jpi
198                     ptrn(ji,jj,jk,jn) = MAX( 0. , ptrn(ji,jj,jk,jn) )
199                     ptrb(ji,jj,jk,jn) = MAX( 0. , ptrb(ji,jj,jk,jn) )
200                  END DO
201               END DO
202            END DO
203            !
204            IF( l_trdtrc ) THEN
205               !
206               zs2rdt = 1. / ( 2. * rdt * REAL( nn_dttrc, wp ) )
207               ztrtrdb(:,:,:) = ( ptrb(:,:,:,jn) - ztrtrdb(:,:,:) ) * zs2rdt
208               ztrtrdn(:,:,:) = ( ptrn(:,:,:,jn) - ztrtrdn(:,:,:) ) * zs2rdt 
209               CALL trd_tra( kt, 'TRC', jn, jptra_radb, ztrtrdb )       ! Asselin-like trend handling
210               CALL trd_tra( kt, 'TRC', jn, jptra_radn, ztrtrdn )       ! standard     trend handling
211              !
212            ENDIF
213            !
214         END DO
215         !
216      ENDIF
217      !
218      IF( l_trdtrc )  DEALLOCATE( ztrtrdb, ztrtrdn )
219      !
220   END SUBROUTINE trc_rad_sms
221
222#else
223   !!----------------------------------------------------------------------
224   !!   Dummy module :                                         NO TOP model
225   !!----------------------------------------------------------------------
226CONTAINS
227   SUBROUTINE trc_rad( kt )              ! Empty routine
228      INTEGER, INTENT(in) ::   kt
229      WRITE(*,*) 'trc_rad: You should not have seen this print! error?', kt
230   END SUBROUTINE trc_rad
231#endif
232   
233   !!======================================================================
234END MODULE trcrad
Note: See TracBrowser for help on using the repository browser.