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

Last change on this file since 10966 was 10966, checked in by acc, 2 years ago

2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : Convert TOP routines in TOP/TRP directory and all knock on effects of these conversions. SETTE tested (GYRE_PISCES only)

File size: 10.2 KB
Line 
1MODULE trcsink
2   !!======================================================================
3   !!                         ***  MODULE trcsink  ***
4   !! TOP :  vertical flux of particulate matter due to gravitational sinking
5   !!======================================================================
6   !! History :   1.0  !  2004     (O. Aumont) Original code
7   !!             2.0  !  2007-12  (C. Ethe, G. Madec)  F90
8   !!             3.4  !  2011-06  (O. Aumont, C. Ethe) Change aggregation formula
9   !!             3.5  !  2012-07  (O. Aumont) Introduce potential time-splitting
10   !!             4.0  !  2018-12  (O. Aumont) Generalize the PISCES code to make it usable by any model
11   !!----------------------------------------------------------------------
12   !!   trc_sink       :  Compute vertical flux of particulate matter due to gravitational sinking
13   !!----------------------------------------------------------------------
14   USE oce_trc         !  shared variables between ocean and passive tracers
15   USE trc             !  passive tracers common variables
16   USE lib_mpp
17
18   IMPLICIT NONE
19   PRIVATE
20
21   PUBLIC trc_sink
22   PUBLIC trc_sink_ini
23
24   INTEGER, PUBLIC :: nitermax      !: Maximum number of iterations for sinking
25
26   !!----------------------------------------------------------------------
27   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
28   !! $Id: trcsink.F90 10069 2018-08-28 14:12:24Z nicolasmartin $
29   !! Software governed by the CeCILL license (see ./LICENSE)
30   !!----------------------------------------------------------------------
31CONTAINS
32
33   !!----------------------------------------------------------------------
34   !!   'standard sinking parameterisation'                  ???
35   !!----------------------------------------------------------------------
36
37   SUBROUTINE trc_sink ( kt, Kbb, Kmm, pwsink, psinkflx, jp_tra, rsfact )
38      !!---------------------------------------------------------------------
39      !!                     ***  ROUTINE trc_sink  ***
40      !!
41      !! ** Purpose :   Compute vertical flux of particulate matter due to
42      !!                gravitational sinking
43      !!
44      !! ** Method  : - ???
45      !!---------------------------------------------------------------------
46      INTEGER , INTENT(in)  :: kt
47      INTEGER , INTENT(in)  :: Kbb, Kmm
48      INTEGER , INTENT(in)  :: jp_tra    ! tracer index index     
49      REAL(wp), INTENT(in)  :: rsfact    ! time step duration
50      REAL(wp), INTENT(in)   , DIMENSION(jpi,jpj,jpk) :: pwsink
51      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) :: psinkflx
52      INTEGER  ::   ji, jj, jk
53      INTEGER, DIMENSION(jpi, jpj) ::   iiter
54      REAL(wp) ::   zfact, zwsmax, zmax
55      REAL(wp), DIMENSION(jpi,jpj,jpk) :: zwsink
56      !!---------------------------------------------------------------------
57      !
58      IF( ln_timing )   CALL timing_start('trc_sink')
59      !
60      !
61      ! OA This is (I hope) a temporary solution for the problem that may
62      ! OA arise in specific situation where the CFL criterion is broken
63      ! OA for vertical sedimentation of particles. To avoid this, a time
64      ! OA splitting algorithm has been coded. A specific maximum
65      ! OA iteration number is provided and may be specified in the namelist
66      ! OA This is to avoid very large iteration number when explicit free
67      ! OA surface is used (for instance). When niter?max is set to 1,
68      ! OA this computation is skipped. The crude old threshold method is
69      ! OA then applied. This also happens when niter exceeds nitermax.
70      IF( nitermax == 1 ) THEN
71         iiter(:,:) = 1
72      ELSE
73         DO jj = 1, jpj
74            DO ji = 1, jpi
75               iiter(ji,jj) = 1
76               DO jk = 1, jpkm1
77                  IF( tmask(ji,jj,jk) == 1.0 ) THEN
78                      zwsmax =  0.5 * e3t(ji,jj,jk,Kmm) * rday / rsfact
79                      iiter(ji,jj) =  MAX( iiter(ji,jj), INT( pwsink(ji,jj,jk) / zwsmax ) )
80                  ENDIF
81               END DO
82            END DO
83         END DO
84         iiter(ji,jj) = MIN( iiter(ji,jj), nitermax )
85      ENDIF
86
87      DO jk = 1,jpkm1
88         DO jj = 1, jpj
89            DO ji = 1, jpi
90               IF( tmask(ji,jj,jk) == 1 ) THEN
91                 zwsmax = 0.5 * e3t(ji,jj,jk,Kmm) * rday / rsfact
92                 zwsink(ji,jj,jk) = MIN( pwsink(ji,jj,jk), zwsmax * REAL( iiter(ji,jj), wp ) )
93               ENDIF
94            END DO
95         END DO
96      END DO
97
98      !  Initializa to zero all the sinking arrays
99      !  -----------------------------------------
100      psinkflx(:,:,:) = 0.e0
101
102      !   Compute the sedimentation term using trc_sink2 for the considered sinking particle
103      !   -----------------------------------------------------
104      CALL trc_sink2( Kbb, Kmm, zwsink, psinkflx, jp_tra, iiter, rsfact )
105      !
106      IF( ln_timing )   CALL timing_stop('trc_sink')
107      !
108   END SUBROUTINE trc_sink
109
110   SUBROUTINE trc_sink2( Kbb, Kmm, pwsink, psinkflx, jp_tra, kiter, rsfact )
111      !!---------------------------------------------------------------------
112      !!                     ***  ROUTINE trc_sink2  ***
113      !!
114      !! ** Purpose :   Compute the sedimentation terms for the various sinking
115      !!     particles. The scheme used to compute the trends is based
116      !!     on MUSCL.
117      !!
118      !! ** Method  : - this ROUTINE compute not exactly the advection but the
119      !!      transport term, i.e.  div(u*tra).
120      !!---------------------------------------------------------------------
121      INTEGER,  INTENT(in   )                         ::   Kbb, Kmm  ! time level indices
122      INTEGER,  INTENT(in   )                         ::   jp_tra    ! tracer index index     
123      REAL(wp), INTENT(in   )                         ::   rsfact    ! duration of time step
124      INTEGER,  INTENT(in   ), DIMENSION(jpi,jpj)     ::   kiter     ! number of iterations for time-splitting
125      REAL(wp), INTENT(in   ), DIMENSION(jpi,jpj,jpk) ::   pwsink    ! sinking speed
126      REAL(wp), INTENT(inout), DIMENSION(jpi,jpj,jpk) ::   psinkflx  ! sinking fluxe
127      !
128      INTEGER  ::   ji, jj, jk, jn
129      REAL(wp) ::   zigma,zew,zign, zflx, zstep
130      REAL(wp), DIMENSION(jpi,jpj,jpk) :: ztraz, zakz, zwsink2, ztrb 
131      !!---------------------------------------------------------------------
132      !
133      IF( ln_timing )   CALL timing_start('trc_sink2')
134      !
135      ztraz(:,:,:) = 0.e0
136      zakz (:,:,:) = 0.e0
137      ztrb (:,:,:) = tr(:,:,:,jp_tra,Kbb)
138
139      DO jk = 1, jpkm1
140         zwsink2(:,:,jk+1) = -pwsink(:,:,jk) / rday * tmask(:,:,jk+1) 
141      END DO
142      zwsink2(:,:,1) = 0.e0
143
144
145      ! Vertical advective flux
146      DO jn = 1, 2
147         !  first guess of the slopes interior values
148         DO jj = 1, jpj
149            DO ji = 1, jpi
150               !
151               zstep = rsfact / REAL( kiter(ji,jj), wp ) / 2.
152               !             
153               DO jk = 2, jpkm1
154                  ztraz(ji,jj,jk) = ( tr(ji,jj,jk-1,jp_tra,Kbb) - tr(ji,jj,jk,jp_tra,Kbb) ) * tmask(ji,jj,jk)
155               END DO
156               ztraz(ji,jj,1  ) = 0.0
157               ztraz(ji,jj,jpk) = 0.0
158
159               ! slopes
160               DO jk = 2, jpkm1
161                  zign = 0.25 + SIGN( 0.25, ztraz(ji,jj,jk) * ztraz(ji,jj,jk+1) )
162                  zakz(ji,jj,jk) = ( ztraz(ji,jj,jk) + ztraz(ji,jj,jk+1) ) * zign
163               END DO
164         
165               ! Slopes limitation
166               DO jk = 2, jpkm1
167                  zakz(ji,jj,jk) = SIGN( 1., zakz(ji,jj,jk) ) *        &
168                     &             MIN( ABS( zakz(ji,jj,jk) ), 2. * ABS(ztraz(ji,jj,jk+1)), 2. * ABS(ztraz(ji,jj,jk) ) )
169               END DO
170         
171               ! vertical advective flux
172               DO jk = 1, jpkm1
173                  zigma = zwsink2(ji,jj,jk+1) * zstep / e3w(ji,jj,jk+1,Kmm)
174                  zew   = zwsink2(ji,jj,jk+1)
175                  psinkflx(ji,jj,jk+1) = -zew * ( tr(ji,jj,jk,jp_tra,Kbb) - 0.5 * ( 1 + zigma ) * zakz(ji,jj,jk) ) * zstep
176               END DO
177               !
178               ! Boundary conditions
179               psinkflx(ji,jj,1  ) = 0.e0
180               psinkflx(ji,jj,jpk) = 0.e0
181         
182               DO jk=1,jpkm1
183                  zflx = ( psinkflx(ji,jj,jk) - psinkflx(ji,jj,jk+1) ) / e3t(ji,jj,jk,Kmm)
184                  tr(ji,jj,jk,jp_tra,Kbb) = tr(ji,jj,jk,jp_tra,Kbb) + zflx
185               END DO
186            END DO
187         END DO
188      END DO
189
190      DO jk = 1,jpkm1
191         DO jj = 1,jpj
192            DO ji = 1, jpi
193               zflx = ( psinkflx(ji,jj,jk) - psinkflx(ji,jj,jk+1) ) / e3t(ji,jj,jk,Kmm)
194               ztrb(ji,jj,jk) = ztrb(ji,jj,jk) + 2. * zflx
195            END DO
196         END DO
197      END DO
198
199      tr(:,:,:,jp_tra,Kbb) = ztrb(:,:,:)
200      psinkflx(:,:,:)   = 2. * psinkflx(:,:,:)
201      !
202      IF( ln_timing )  CALL timing_stop('trc_sink2')
203      !
204   END SUBROUTINE trc_sink2
205
206  SUBROUTINE trc_sink_ini
207      !!---------------------------------------------------------------------
208      !!                  ***  ROUTINE trc_sink_ini ***
209      !!
210      !! ** Purpose :   read  namelist options
211      !!----------------------------------------------------------------------
212      INTEGER ::   ios   ! Local integer output status for namelist read
213      !!
214      NAMELIST/namtrc_snk/ nitermax
215      !!----------------------------------------------------------------------
216      !
217      REWIND( numnat_ref )              ! namtrc_rad in reference namelist
218      READ  ( numnat_ref, namtrc_snk, IOSTAT = ios, ERR = 907)
219907   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtrc_snk in reference namelist', lwp )
220      REWIND( numnat_cfg )              ! namtrc_rad in configuration namelist
221      READ  ( numnat_cfg, namtrc_snk, IOSTAT = ios, ERR = 908 )
222908   IF( ios > 0 )   CALL ctl_nam ( ios , 'namtrc_snk in configuration namelist', lwp )
223      IF(lwm) WRITE( numont, namtrc_snk )
224
225      IF(lwp) THEN                     !   ! Control print
226         WRITE(numout,*)
227         WRITE(numout,*) 'trc_sink : Sedimentation of particles '
228         WRITE(numout,*) '~~~~~~~ '
229         WRITE(numout,*) '   Namelist namtrc_snk : sedimentation of particles'
230         WRITE(numout,*) '   Maximum number of iterations   nitermax = ', nitermax
231         WRITE(numout,*)
232      ENDIF
233
234   END SUBROUTINE trc_sink_ini
235
236   !!======================================================================
237END MODULE trcsink
Note: See TracBrowser for help on using the repository browser.