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.
diaptr.F90 in NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/DIA – NEMO

source: NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/DIA/diaptr.F90 @ 11960

Last change on this file since 11960 was 11960, checked in by acc, 4 years ago

Branch 2019/dev_r11943_MERGE_2019. Merge in changes from 2019/dev_r11613_ENHANCE-04_namelists_as_internalfiles. (svn merge -r 11614:11954). Resolved tree conflicts and one actual conflict. Sette tested(these changes alter the ext/AGRIF reference; remember to update). See ticket #2341
  • Property svn:keywords set to Id
File size: 30.1 KB
Line 
1MODULE diaptr
2   !!======================================================================
3   !!                       ***  MODULE  diaptr  ***
4   !! Ocean physics:  Computes meridonal transports and zonal means
5   !!=====================================================================
6   !! History :  1.0  ! 2003-09  (C. Talandier, G. Madec)  Original code
7   !!            2.0  ! 2006-01  (A. Biastoch)  Allow sub-basins computation
8   !!            3.2  ! 2010-03  (O. Marti, S. Flavoni) Add fields
9   !!            3.3  ! 2010-10  (G. Madec)  dynamical allocation
10   !!            3.6  ! 2014-12  (C. Ethe) use of IOM
11   !!            3.6  ! 2016-06  (T. Graham) Addition of diagnostics for CMIP6
12   !!----------------------------------------------------------------------
13
14   !!----------------------------------------------------------------------
15   !!   dia_ptr      : Poleward Transport Diagnostics module
16   !!   dia_ptr_init : Initialization, namelist read
17   !!   ptr_sjk      : "zonal" mean computation of a field - tracer or flux array
18   !!   ptr_sj       : "zonal" and vertical sum computation of a "meridional" flux array
19   !!                   (Generic interface to ptr_sj_3d, ptr_sj_2d)
20   !!----------------------------------------------------------------------
21   USE oce              ! ocean dynamics and active tracers
22   USE dom_oce          ! ocean space and time domain
23   USE phycst           ! physical constants
24   !
25   USE iom              ! IOM library
26   USE in_out_manager   ! I/O manager
27   USE lib_mpp          ! MPP library
28   USE timing           ! preformance summary
29
30   IMPLICIT NONE
31   PRIVATE
32
33   INTERFACE ptr_sj
34      MODULE PROCEDURE ptr_sj_3d, ptr_sj_2d
35   END INTERFACE
36
37   PUBLIC   ptr_sj         ! call by tra_ldf & tra_adv routines
38   PUBLIC   ptr_sjk        !
39   PUBLIC   dia_ptr_init   ! call in memogcm
40   PUBLIC   dia_ptr        ! call in step module
41   PUBLIC   dia_ptr_hst    ! called from tra_ldf/tra_adv routines
42
43   !                                  !!** namelist  namptr  **
44   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   htr_adv, htr_ldf, htr_eiv   !: Heat TRansports (adv, diff, Bolus.)
45   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   str_adv, str_ldf, str_eiv   !: Salt TRansports (adv, diff, Bolus.)
46   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   htr_ove, str_ove   !: heat Salt TRansports ( overturn.)
47   REAL(wp), ALLOCATABLE, SAVE, PUBLIC, DIMENSION(:,:) ::   htr_btr, str_btr   !: heat Salt TRansports ( barotropic )
48
49   LOGICAL, PUBLIC ::   ln_diaptr   !  Poleward transport flag (T) or not (F)
50   LOGICAL, PUBLIC ::   ln_subbas   !  Atlantic/Pacific/Indian basins calculation
51   INTEGER, PUBLIC ::   nptr        ! = 1 (l_subbas=F) or = 5 (glo, atl, pac, ind, ipc) (l_subbas=T)
52
53   REAL(wp) ::   rc_sv    = 1.e-6_wp   ! conversion from m3/s to Sverdrup
54   REAL(wp) ::   rc_pwatt = 1.e-15_wp  ! conversion from W    to PW (further x rau0 x Cp)
55   REAL(wp) ::   rc_ggram = 1.e-6_wp   ! conversion from g    to Pg
56
57   CHARACTER(len=3), ALLOCATABLE, SAVE, DIMENSION(:)     :: clsubb
58   REAL(wp),         ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: btmsk   ! T-point basin interior masks
59   REAL(wp),         ALLOCATABLE, SAVE, DIMENSION(:,:)   :: btm30   ! mask out Southern Ocean (=0 south of 30°S)
60
61   REAL(wp), TARGET, ALLOCATABLE, SAVE, DIMENSION(:)     :: p_fval1d
62   REAL(wp), TARGET, ALLOCATABLE, SAVE, DIMENSION(:,:)   :: p_fval2d
63
64   !! * Substitutions
65#  include "vectopt_loop_substitute.h90"
66   !!----------------------------------------------------------------------
67   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
68   !! $Id$
69   !! Software governed by the CeCILL license (see ./LICENSE)
70   !!----------------------------------------------------------------------
71CONTAINS
72
73   SUBROUTINE dia_ptr( Kmm, pvtr )
74      !!----------------------------------------------------------------------
75      !!                  ***  ROUTINE dia_ptr  ***
76      !!----------------------------------------------------------------------
77      INTEGER                         , INTENT(in)           ::   Kmm    ! time level index
78      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in), OPTIONAL ::   pvtr   ! j-effective transport
79      !
80      INTEGER  ::   ji, jj, jk, jn   ! dummy loop indices
81      REAL(wp) ::   zsfc,zvfc               ! local scalar
82      REAL(wp), DIMENSION(jpi,jpj)     ::  z2d   ! 2D workspace
83      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  z3d   ! 3D workspace
84      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  zmask   ! 3D workspace
85      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts) ::  zts   ! 3D workspace
86      REAL(wp), DIMENSION(jpj)     ::  vsum   ! 1D workspace
87      REAL(wp), DIMENSION(jpj,jpts)     ::  tssum   ! 1D workspace
88 
89      !
90      !overturning calculation
91      REAL(wp), DIMENSION(jpj,jpk,nptr) ::   sjk  , r1_sjk ! i-mean i-k-surface and its inverse
92      REAL(wp), DIMENSION(jpj,jpk,nptr) ::   v_msf, sn_jk  , tn_jk ! i-mean T and S, j-Stream-Function
93      REAL(wp), DIMENSION(jpi,jpj,jpk) ::  zvv   ! 3D workspace
94
95
96      CHARACTER( len = 12 )  :: cl1
97      !!----------------------------------------------------------------------
98      !
99      IF( ln_timing )   CALL timing_start('dia_ptr')
100
101      !
102      IF( PRESENT( pvtr ) ) THEN
103         IF( iom_use("zomsfglo") ) THEN    ! effective MSF
104            z3d(1,:,:) = ptr_sjk( pvtr(:,:,:) )  ! zonal cumulative effective transport
105            DO jk = 2, jpkm1 
106              z3d(1,:,jk) = z3d(1,:,jk-1) + z3d(1,:,jk)   ! effective j-Stream-Function (MSF)
107            END DO
108            DO ji = 1, jpi
109               z3d(ji,:,:) = z3d(1,:,:)
110            ENDDO
111            cl1 = TRIM('zomsf'//clsubb(1) )
112            CALL iom_put( cl1, z3d * rc_sv )
113            DO jn = 2, nptr                                    ! by sub-basins
114               z3d(1,:,:) =  ptr_sjk( pvtr(:,:,:), btmsk(:,:,jn)*btm30(:,:) ) 
115               DO jk = 2, jpkm1 
116                  z3d(1,:,jk) = z3d(1,:,jk-1) + z3d(1,:,jk)    ! effective j-Stream-Function (MSF)
117               END DO
118               DO ji = 1, jpi
119                  z3d(ji,:,:) = z3d(1,:,:)
120               ENDDO
121               cl1 = TRIM('zomsf'//clsubb(jn) )
122               CALL iom_put( cl1, z3d * rc_sv )
123            END DO
124         ENDIF
125         IF( iom_use("sopstove") .OR. iom_use("sophtove") .OR. iom_use("sopstbtr") .OR. iom_use("sophtbtr") ) THEN
126            ! define fields multiplied by scalar
127            zmask(:,:,:) = 0._wp
128            zts(:,:,:,:) = 0._wp
129            zvv(:,:,:) = 0._wp
130            DO jk = 1, jpkm1
131               DO jj = 1, jpjm1
132                  DO ji = 1, jpi
133                     zvfc = e1v(ji,jj) * e3v(ji,jj,jk,Kmm)
134                     zmask(ji,jj,jk)      = vmask(ji,jj,jk)      * zvfc
135                     zts(ji,jj,jk,jp_tem) = (ts(ji,jj,jk,jp_tem,Kmm)+ts(ji,jj+1,jk,jp_tem,Kmm)) * 0.5 * zvfc  !Tracers averaged onto V grid
136                     zts(ji,jj,jk,jp_sal) = (ts(ji,jj,jk,jp_sal,Kmm)+ts(ji,jj+1,jk,jp_sal,Kmm)) * 0.5 * zvfc
137                     zvv(ji,jj,jk)        = vv(ji,jj,jk,Kmm)         * zvfc
138                  ENDDO
139               ENDDO
140             ENDDO
141         ENDIF
142         IF( iom_use("sopstove") .OR. iom_use("sophtove") ) THEN
143             sjk(:,:,1) = ptr_sjk( zmask(:,:,:), btmsk(:,:,1) )
144             r1_sjk(:,:,1) = 0._wp
145             WHERE( sjk(:,:,1) /= 0._wp )   r1_sjk(:,:,1) = 1._wp / sjk(:,:,1)
146
147             ! i-mean T and S, j-Stream-Function, global
148             tn_jk(:,:,1) = ptr_sjk( zts(:,:,:,jp_tem) ) * r1_sjk(:,:,1)
149             sn_jk(:,:,1) = ptr_sjk( zts(:,:,:,jp_sal) ) * r1_sjk(:,:,1)
150             v_msf(:,:,1) = ptr_sjk( zvv(:,:,:) )
151
152             htr_ove(:,1) = SUM( v_msf(:,:,1)*tn_jk(:,:,1) ,2 )
153             str_ove(:,1) = SUM( v_msf(:,:,1)*sn_jk(:,:,1) ,2 )
154
155             z2d(1,:) = htr_ove(:,1) * rc_pwatt        !  (conversion in PW)
156             DO ji = 1, jpi
157               z2d(ji,:) = z2d(1,:)
158             ENDDO
159             cl1 = 'sophtove'
160             CALL iom_put( TRIM(cl1), z2d )
161             z2d(1,:) = str_ove(:,1) * rc_ggram        !  (conversion in Gg)
162             DO ji = 1, jpi
163               z2d(ji,:) = z2d(1,:)
164             ENDDO
165             cl1 = 'sopstove'
166             CALL iom_put( TRIM(cl1), z2d )
167             IF( ln_subbas ) THEN
168                DO jn = 2, nptr
169                    sjk(:,:,jn) = ptr_sjk( zmask(:,:,:), btmsk(:,:,jn) )
170                    r1_sjk(:,:,jn) = 0._wp
171                    WHERE( sjk(:,:,jn) /= 0._wp )   r1_sjk(:,:,jn) = 1._wp / sjk(:,:,jn)
172
173                    ! i-mean T and S, j-Stream-Function, basin
174                    tn_jk(:,:,jn) = ptr_sjk( zts(:,:,:,jp_tem), btmsk(:,:,jn) ) * r1_sjk(:,:,jn)
175                    sn_jk(:,:,jn) = ptr_sjk( zts(:,:,:,jp_sal), btmsk(:,:,jn) ) * r1_sjk(:,:,jn)
176                    v_msf(:,:,jn) = ptr_sjk( zvv(:,:,:), btmsk(:,:,jn) ) 
177                    htr_ove(:,jn) = SUM( v_msf(:,:,jn)*tn_jk(:,:,jn) ,2 )
178                    str_ove(:,jn) = SUM( v_msf(:,:,jn)*sn_jk(:,:,jn) ,2 )
179
180                    z2d(1,:) = htr_ove(:,jn) * rc_pwatt !  (conversion in PW)
181                    DO ji = 1, jpi
182                        z2d(ji,:) = z2d(1,:)
183                    ENDDO
184                    cl1 = TRIM('sophtove_'//clsubb(jn))
185                    CALL iom_put( cl1, z2d )
186                    z2d(1,:) = str_ove(:,jn) * rc_ggram        ! (conversion in Gg)
187                    DO ji = 1, jpi
188                        z2d(ji,:) = z2d(1,:)
189                    ENDDO
190                    cl1 = TRIM('sopstove_'//clsubb(jn))
191                    CALL iom_put( cl1, z2d )
192                END DO
193             ENDIF
194         ENDIF
195         IF( iom_use("sopstbtr") .OR. iom_use("sophtbtr") ) THEN
196         ! Calculate barotropic heat and salt transport here
197             sjk(:,1,1) = ptr_sj( zmask(:,:,:), btmsk(:,:,1) )
198             r1_sjk(:,1,1) = 0._wp
199             WHERE( sjk(:,1,1) /= 0._wp )   r1_sjk(:,1,1) = 1._wp / sjk(:,1,1)
200           
201            vsum = ptr_sj( zvv(:,:,:), btmsk(:,:,1))
202            tssum(:,jp_tem) = ptr_sj( zts(:,:,:,jp_tem), btmsk(:,:,1) )
203            tssum(:,jp_sal) = ptr_sj( zts(:,:,:,jp_sal), btmsk(:,:,1) )
204            htr_btr(:,1) = vsum * tssum(:,jp_tem) * r1_sjk(:,1,1)
205            str_btr(:,1) = vsum * tssum(:,jp_sal) * r1_sjk(:,1,1)
206            z2d(1,:) = htr_btr(:,1) * rc_pwatt        !  (conversion in PW)
207            DO ji = 2, jpi
208               z2d(ji,:) = z2d(1,:)
209            ENDDO
210            cl1 = 'sophtbtr'
211            CALL iom_put( TRIM(cl1), z2d )
212            z2d(1,:) = str_btr(:,1) * rc_ggram        !  (conversion in Gg)
213            DO ji = 2, jpi
214              z2d(ji,:) = z2d(1,:)
215            ENDDO
216            cl1 = 'sopstbtr'
217            CALL iom_put( TRIM(cl1), z2d )
218            IF( ln_subbas ) THEN
219                DO jn = 2, nptr
220                    sjk(:,1,jn) = ptr_sj( zmask(:,:,:), btmsk(:,:,jn) )
221                    r1_sjk(:,1,jn) = 0._wp
222                    WHERE( sjk(:,1,jn) /= 0._wp )   r1_sjk(:,1,jn) = 1._wp / sjk(:,1,jn)
223                    vsum = ptr_sj( zvv(:,:,:), btmsk(:,:,jn))
224                    tssum(:,jp_tem) = ptr_sj( zts(:,:,:,jp_tem), btmsk(:,:,jn) )
225                    tssum(:,jp_sal) = ptr_sj( zts(:,:,:,jp_sal), btmsk(:,:,jn) )
226                    htr_btr(:,jn) = vsum * tssum(:,jp_tem) * r1_sjk(:,1,jn)
227                    str_btr(:,jn) = vsum * tssum(:,jp_sal) * r1_sjk(:,1,jn)
228                    z2d(1,:) = htr_btr(:,jn) * rc_pwatt !  (conversion in PW)
229                    DO ji = 1, jpi
230                        z2d(ji,:) = z2d(1,:)
231                    ENDDO
232                    cl1 = TRIM('sophtbtr_'//clsubb(jn))
233                    CALL iom_put( cl1, z2d )
234                    z2d(1,:) = str_btr(:,jn) * rc_ggram        ! (conversion in Gg)
235                    DO ji = 1, jpi
236                        z2d(ji,:) = z2d(1,:)
237                    ENDDO
238                    cl1 = TRIM('sopstbtr_'//clsubb(jn))
239                    CALL iom_put( cl1, z2d )
240               ENDDO
241            ENDIF !ln_subbas
242         ENDIF !iom_use("sopstbtr....)
243         !
244      ELSE
245         !
246         IF( iom_use("zotemglo") ) THEN    ! i-mean i-k-surface
247            DO jk = 1, jpkm1
248               DO jj = 1, jpj
249                  DO ji = 1, jpi
250                     zsfc = e1t(ji,jj) * e3t(ji,jj,jk,Kmm)
251                     zmask(ji,jj,jk)      = tmask(ji,jj,jk)      * zsfc
252                     zts(ji,jj,jk,jp_tem) = ts(ji,jj,jk,jp_tem,Kmm) * zsfc
253                     zts(ji,jj,jk,jp_sal) = ts(ji,jj,jk,jp_sal,Kmm) * zsfc
254                  END DO
255               END DO
256            END DO
257            DO jn = 1, nptr
258               zmask(1,:,:) = ptr_sjk( zmask(:,:,:), btmsk(:,:,jn) )
259               cl1 = TRIM('zosrf'//clsubb(jn) )
260               CALL iom_put( cl1, zmask )
261               !
262               z3d(1,:,:) = ptr_sjk( zts(:,:,:,jp_tem), btmsk(:,:,jn) ) &
263                  &            / MAX( zmask(1,:,:), 10.e-15 )
264               DO ji = 1, jpi
265                  z3d(ji,:,:) = z3d(1,:,:)
266               ENDDO
267               cl1 = TRIM('zotem'//clsubb(jn) )
268               CALL iom_put( cl1, z3d )
269               !
270               z3d(1,:,:) = ptr_sjk( zts(:,:,:,jp_sal), btmsk(:,:,jn) ) &
271                  &            / MAX( zmask(1,:,:), 10.e-15 )
272               DO ji = 1, jpi
273                  z3d(ji,:,:) = z3d(1,:,:)
274               ENDDO
275               cl1 = TRIM('zosal'//clsubb(jn) )
276               CALL iom_put( cl1, z3d )
277            END DO
278         ENDIF
279         !
280         !                                ! Advective and diffusive heat and salt transport
281         IF( iom_use("sophtadv") .OR. iom_use("sopstadv") ) THEN   
282            z2d(1,:) = htr_adv(:,1) * rc_pwatt        !  (conversion in PW)
283            DO ji = 1, jpi
284               z2d(ji,:) = z2d(1,:)
285            ENDDO
286            cl1 = 'sophtadv'                 
287            CALL iom_put( TRIM(cl1), z2d )
288            z2d(1,:) = str_adv(:,1) * rc_ggram        ! (conversion in Gg)
289            DO ji = 1, jpi
290               z2d(ji,:) = z2d(1,:)
291            ENDDO
292            cl1 = 'sopstadv'
293            CALL iom_put( TRIM(cl1), z2d )
294            IF( ln_subbas ) THEN
295              DO jn=2,nptr
296               z2d(1,:) = htr_adv(:,jn) * rc_pwatt        !  (conversion in PW)
297               DO ji = 1, jpi
298                 z2d(ji,:) = z2d(1,:)
299               ENDDO
300               cl1 = TRIM('sophtadv_'//clsubb(jn))                 
301               CALL iom_put( cl1, z2d )
302               z2d(1,:) = str_adv(:,jn) * rc_ggram        ! (conversion in Gg)
303               DO ji = 1, jpi
304                  z2d(ji,:) = z2d(1,:)
305               ENDDO
306               cl1 = TRIM('sopstadv_'//clsubb(jn))                 
307               CALL iom_put( cl1, z2d )             
308              ENDDO
309            ENDIF
310         ENDIF
311         !
312         IF( iom_use("sophtldf") .OR. iom_use("sopstldf") ) THEN   
313            z2d(1,:) = htr_ldf(:,1) * rc_pwatt        !  (conversion in PW)
314            DO ji = 1, jpi
315               z2d(ji,:) = z2d(1,:)
316            ENDDO
317            cl1 = 'sophtldf'
318            CALL iom_put( TRIM(cl1), z2d )
319            z2d(1,:) = str_ldf(:,1) * rc_ggram        !  (conversion in Gg)
320            DO ji = 1, jpi
321               z2d(ji,:) = z2d(1,:)
322            ENDDO
323            cl1 = 'sopstldf'
324            CALL iom_put( TRIM(cl1), z2d )
325            IF( ln_subbas ) THEN
326              DO jn=2,nptr
327               z2d(1,:) = htr_ldf(:,jn) * rc_pwatt        !  (conversion in PW)
328               DO ji = 1, jpi
329                 z2d(ji,:) = z2d(1,:)
330               ENDDO
331               cl1 = TRIM('sophtldf_'//clsubb(jn))                 
332               CALL iom_put( cl1, z2d )
333               z2d(1,:) = str_ldf(:,jn) * rc_ggram        ! (conversion in Gg)
334               DO ji = 1, jpi
335                  z2d(ji,:) = z2d(1,:)
336               ENDDO
337               cl1 = TRIM('sopstldf_'//clsubb(jn))                 
338               CALL iom_put( cl1, z2d )             
339              ENDDO
340            ENDIF
341         ENDIF
342
343         IF( iom_use("sophteiv") .OR. iom_use("sopsteiv") ) THEN
344            z2d(1,:) = htr_eiv(:,1) * rc_pwatt        !  (conversion in PW)
345            DO ji = 1, jpi
346               z2d(ji,:) = z2d(1,:)
347            ENDDO
348            cl1 = 'sophteiv'
349            CALL iom_put( TRIM(cl1), z2d )
350            z2d(1,:) = str_eiv(:,1) * rc_ggram        !  (conversion in Gg)
351            DO ji = 1, jpi
352               z2d(ji,:) = z2d(1,:)
353            ENDDO
354            cl1 = 'sopsteiv'
355            CALL iom_put( TRIM(cl1), z2d )
356            IF( ln_subbas ) THEN
357               DO jn=2,nptr
358                  z2d(1,:) = htr_eiv(:,jn) * rc_pwatt        !  (conversion in PW)
359                  DO ji = 1, jpi
360                     z2d(ji,:) = z2d(1,:)
361                  ENDDO
362                  cl1 = TRIM('sophteiv_'//clsubb(jn))                 
363                  CALL iom_put( cl1, z2d )
364                  z2d(1,:) = str_eiv(:,jn) * rc_ggram        ! (conversion in Gg)
365                  DO ji = 1, jpi
366                     z2d(ji,:) = z2d(1,:)
367                  ENDDO
368                  cl1 = TRIM('sopsteiv_'//clsubb(jn)) 
369                  CALL iom_put( cl1, z2d )             
370               ENDDO
371            ENDIF
372         ENDIF
373         !
374      ENDIF
375      !
376      IF( ln_timing )   CALL timing_stop('dia_ptr')
377      !
378   END SUBROUTINE dia_ptr
379
380
381   SUBROUTINE dia_ptr_init
382      !!----------------------------------------------------------------------
383      !!                  ***  ROUTINE dia_ptr_init  ***
384      !!                   
385      !! ** Purpose :   Initialization, namelist read
386      !!----------------------------------------------------------------------
387      INTEGER ::  jn           ! local integers
388      INTEGER ::  inum, ierr   ! local integers
389      INTEGER ::  ios          ! Local integer output status for namelist read
390      !!
391      NAMELIST/namptr/ ln_diaptr, ln_subbas
392      !!----------------------------------------------------------------------
393
394      READ  ( numnam_ref, namptr, IOSTAT = ios, ERR = 901)
395901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namptr in reference namelist' )
396
397      READ  ( numnam_cfg, namptr, IOSTAT = ios, ERR = 902 )
398902   IF( ios >  0 ) CALL ctl_nam ( ios , 'namptr in configuration namelist' )
399      IF(lwm) WRITE ( numond, namptr )
400
401      IF(lwp) THEN                     ! Control print
402         WRITE(numout,*)
403         WRITE(numout,*) 'dia_ptr_init : poleward transport and msf initialization'
404         WRITE(numout,*) '~~~~~~~~~~~~'
405         WRITE(numout,*) '   Namelist namptr : set ptr parameters'
406         WRITE(numout,*) '      Poleward heat & salt transport (T) or not (F)      ln_diaptr  = ', ln_diaptr
407         WRITE(numout,*) '      Global (F) or glo/Atl/Pac/Ind/Indo-Pac basins      ln_subbas  = ', ln_subbas
408      ENDIF
409
410      IF( ln_diaptr ) THEN 
411         !
412         IF( ln_subbas ) THEN
413            nptr = 5            ! Global, Atlantic, Pacific, Indian, Indo-Pacific
414            ALLOCATE( clsubb(nptr) )
415            clsubb(1) = 'glo' ;  clsubb(2) = 'atl'  ;  clsubb(3) = 'pac'  ;  clsubb(4) = 'ind'  ;  clsubb(5) = 'ipc'
416         ELSE               
417            nptr = 1       ! Global only
418            ALLOCATE( clsubb(nptr) )
419            clsubb(1) = 'glo' 
420         ENDIF
421
422         !                                      ! allocate dia_ptr arrays
423         IF( dia_ptr_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'dia_ptr_init : unable to allocate arrays' )
424
425         rc_pwatt = rc_pwatt * rau0_rcp          ! conversion from K.s-1 to PetaWatt
426
427         IF( lk_mpp )   CALL mpp_ini_znl( numout )     ! Define MPI communicator for zonal sum
428
429         IF( ln_subbas ) THEN                ! load sub-basin mask
430            CALL iom_open( 'subbasins', inum,  ldstop = .FALSE.  )
431            CALL iom_get( inum, jpdom_data, 'atlmsk', btmsk(:,:,2) )   ! Atlantic basin
432            CALL iom_get( inum, jpdom_data, 'pacmsk', btmsk(:,:,3) )   ! Pacific  basin
433            CALL iom_get( inum, jpdom_data, 'indmsk', btmsk(:,:,4) )   ! Indian   basin
434            CALL iom_close( inum )
435            btmsk(:,:,5) = MAX ( btmsk(:,:,3), btmsk(:,:,4) )          ! Indo-Pacific basin
436            WHERE( gphit(:,:) < -30._wp)   ;   btm30(:,:) = 0._wp      ! mask out Southern Ocean
437            ELSE WHERE                     ;   btm30(:,:) = ssmask(:,:)
438            END WHERE
439         ENDIF
440   
441         btmsk(:,:,1) = tmask_i(:,:)                                   ! global ocean
442     
443         DO jn = 1, nptr
444            btmsk(:,:,jn) = btmsk(:,:,jn) * tmask_i(:,:)               ! interior domain only
445         END DO
446
447         ! Initialise arrays to zero because diatpr is called before they are first calculated
448         ! Note that this means diagnostics will not be exactly correct when model run is restarted.
449         htr_adv(:,:) = 0._wp  ;  str_adv(:,:) =  0._wp 
450         htr_ldf(:,:) = 0._wp  ;  str_ldf(:,:) =  0._wp 
451         htr_eiv(:,:) = 0._wp  ;  str_eiv(:,:) =  0._wp 
452         htr_ove(:,:) = 0._wp  ;   str_ove(:,:) =  0._wp
453         htr_btr(:,:) = 0._wp  ;   str_btr(:,:) =  0._wp
454         !
455      ENDIF 
456      !
457   END SUBROUTINE dia_ptr_init
458
459
460   SUBROUTINE dia_ptr_hst( ktra, cptr, pvflx ) 
461      !!----------------------------------------------------------------------
462      !!                    ***  ROUTINE dia_ptr_hst ***
463      !!----------------------------------------------------------------------
464      !! Wrapper for heat and salt transport calculations to calculate them for each basin
465      !! Called from all advection and/or diffusion routines
466      !!----------------------------------------------------------------------
467      INTEGER                         , INTENT(in )  :: ktra  ! tracer index
468      CHARACTER(len=3)                , INTENT(in)   :: cptr  ! transport type  'adv'/'ldf'/'eiv'
469      REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in)   :: pvflx   ! 3D input array of advection/diffusion
470      INTEGER                                        :: jn    !
471
472      IF( cptr == 'adv' ) THEN
473         IF( ktra == jp_tem )  htr_adv(:,1) = ptr_sj( pvflx )
474         IF( ktra == jp_sal )  str_adv(:,1) = ptr_sj( pvflx )
475      ENDIF
476      IF( cptr == 'ldf' ) THEN
477         IF( ktra == jp_tem )  htr_ldf(:,1) = ptr_sj( pvflx )
478         IF( ktra == jp_sal )  str_ldf(:,1) = ptr_sj( pvflx )
479      ENDIF
480      IF( cptr == 'eiv' ) THEN
481         IF( ktra == jp_tem )  htr_eiv(:,1) = ptr_sj( pvflx )
482         IF( ktra == jp_sal )  str_eiv(:,1) = ptr_sj( pvflx )
483      ENDIF
484      !
485      IF( ln_subbas ) THEN
486         !
487         IF( cptr == 'adv' ) THEN
488             IF( ktra == jp_tem ) THEN
489                DO jn = 2, nptr
490                   htr_adv(:,jn) = ptr_sj( pvflx, btmsk(:,:,jn) )
491                END DO
492             ENDIF
493             IF( ktra == jp_sal ) THEN
494                DO jn = 2, nptr
495                   str_adv(:,jn) = ptr_sj( pvflx, btmsk(:,:,jn) )
496                END DO
497             ENDIF
498         ENDIF
499         IF( cptr == 'ldf' ) THEN
500             IF( ktra == jp_tem ) THEN
501                DO jn = 2, nptr
502                    htr_ldf(:,jn) = ptr_sj( pvflx, btmsk(:,:,jn) )
503                 END DO
504             ENDIF
505             IF( ktra == jp_sal ) THEN
506                DO jn = 2, nptr
507                   str_ldf(:,jn) = ptr_sj( pvflx, btmsk(:,:,jn) )
508                END DO
509             ENDIF
510         ENDIF
511         IF( cptr == 'eiv' ) THEN
512             IF( ktra == jp_tem ) THEN
513                DO jn = 2, nptr
514                    htr_eiv(:,jn) = ptr_sj( pvflx, btmsk(:,:,jn) )
515                 END DO
516             ENDIF
517             IF( ktra == jp_sal ) THEN
518                DO jn = 2, nptr
519                   str_eiv(:,jn) = ptr_sj( pvflx, btmsk(:,:,jn) )
520                END DO
521             ENDIF
522         ENDIF
523         !
524      ENDIF
525   END SUBROUTINE dia_ptr_hst
526
527
528   FUNCTION dia_ptr_alloc()
529      !!----------------------------------------------------------------------
530      !!                    ***  ROUTINE dia_ptr_alloc  ***
531      !!----------------------------------------------------------------------
532      INTEGER               ::   dia_ptr_alloc   ! return value
533      INTEGER, DIMENSION(3) ::   ierr
534      !!----------------------------------------------------------------------
535      ierr(:) = 0
536      !
537      ALLOCATE( btmsk(jpi,jpj,nptr) ,              &
538         &      htr_adv(jpj,nptr) , str_adv(jpj,nptr) ,   &
539         &      htr_eiv(jpj,nptr) , str_eiv(jpj,nptr) ,   &
540         &      htr_ove(jpj,nptr) , str_ove(jpj,nptr) ,   &
541         &      htr_btr(jpj,nptr) , str_btr(jpj,nptr) ,   &
542         &      htr_ldf(jpj,nptr) , str_ldf(jpj,nptr) , STAT=ierr(1)  )
543         !
544      ALLOCATE( p_fval1d(jpj), p_fval2d(jpj,jpk), Stat=ierr(2))
545      !
546      ALLOCATE( btm30(jpi,jpj), STAT=ierr(3)  )
547
548         !
549      dia_ptr_alloc = MAXVAL( ierr )
550      CALL mpp_sum( 'diaptr', dia_ptr_alloc )
551      !
552   END FUNCTION dia_ptr_alloc
553
554
555   FUNCTION ptr_sj_3d( pvflx, pmsk )   RESULT ( p_fval )
556      !!----------------------------------------------------------------------
557      !!                    ***  ROUTINE ptr_sj_3d  ***
558      !!
559      !! ** Purpose :   i-k sum computation of a j-flux array
560      !!
561      !! ** Method  : - i-k sum of pvflx using the interior 2D vmask (vmask_i).
562      !!              pvflx is supposed to be a masked flux (i.e. * vmask*e1v*e3v)
563      !!
564      !! ** Action  : - p_fval: i-k-mean poleward flux of pvflx
565      !!----------------------------------------------------------------------
566      REAL(wp), INTENT(in), DIMENSION(jpi,jpj,jpk)       ::   pvflx   ! mask flux array at V-point
567      REAL(wp), INTENT(in), DIMENSION(jpi,jpj), OPTIONAL ::   pmsk   ! Optional 2D basin mask
568      !
569      INTEGER                  ::   ji, jj, jk   ! dummy loop arguments
570      INTEGER                  ::   ijpj         ! ???
571      REAL(wp), POINTER, DIMENSION(:) :: p_fval  ! function value
572      !!--------------------------------------------------------------------
573      !
574      p_fval => p_fval1d
575
576      ijpj = jpj
577      p_fval(:) = 0._wp
578      IF( PRESENT( pmsk ) ) THEN
579         DO jk = 1, jpkm1
580            DO jj = 2, jpjm1
581               DO ji = fs_2, fs_jpim1   ! Vector opt.
582                  p_fval(jj) = p_fval(jj) + pvflx(ji,jj,jk) * tmask_i(ji,jj) * pmsk(ji,jj)
583               END DO
584            END DO
585         END DO
586      ELSE
587         DO jk = 1, jpkm1
588            DO jj = 2, jpjm1
589               DO ji = fs_2, fs_jpim1   ! Vector opt.
590                  p_fval(jj) = p_fval(jj) + pvflx(ji,jj,jk) * tmask_i(ji,jj) 
591               END DO
592            END DO
593         END DO
594      ENDIF
595#if defined key_mpp_mpi
596      CALL mpp_sum( 'diaptr', p_fval, ijpj, ncomm_znl)
597#endif
598      !
599   END FUNCTION ptr_sj_3d
600
601
602   FUNCTION ptr_sj_2d( pvflx, pmsk )   RESULT ( p_fval )
603      !!----------------------------------------------------------------------
604      !!                    ***  ROUTINE ptr_sj_2d  ***
605      !!
606      !! ** Purpose :   "zonal" and vertical sum computation of a j-flux array
607      !!
608      !! ** Method  : - i-k sum of pvflx using the interior 2D vmask (vmask_i).
609      !!      pvflx is supposed to be a masked flux (i.e. * vmask*e1v*e3v)
610      !!
611      !! ** Action  : - p_fval: i-k-mean poleward flux of pvflx
612      !!----------------------------------------------------------------------
613      REAL(wp) , INTENT(in), DIMENSION(jpi,jpj)           ::   pvflx   ! mask flux array at V-point
614      REAL(wp) , INTENT(in), DIMENSION(jpi,jpj), OPTIONAL ::   pmsk   ! Optional 2D basin mask
615      !
616      INTEGER                  ::   ji,jj       ! dummy loop arguments
617      INTEGER                  ::   ijpj        ! ???
618      REAL(wp), POINTER, DIMENSION(:) :: p_fval ! function value
619      !!--------------------------------------------------------------------
620      !
621      p_fval => p_fval1d
622
623      ijpj = jpj
624      p_fval(:) = 0._wp
625      IF( PRESENT( pmsk ) ) THEN
626         DO jj = 2, jpjm1
627            DO ji = nldi, nlei   ! No vector optimisation here. Better use a mask ?
628               p_fval(jj) = p_fval(jj) + pvflx(ji,jj) * tmask_i(ji,jj) * pmsk(ji,jj)
629            END DO
630         END DO
631      ELSE
632         DO jj = 2, jpjm1
633            DO ji = nldi, nlei   ! No vector optimisation here. Better use a mask ?
634               p_fval(jj) = p_fval(jj) + pvflx(ji,jj) * tmask_i(ji,jj)
635            END DO
636         END DO
637      ENDIF
638#if defined key_mpp_mpi
639      CALL mpp_sum( 'diaptr', p_fval, ijpj, ncomm_znl )
640#endif
641      !
642   END FUNCTION ptr_sj_2d
643
644
645   FUNCTION ptr_sjk( pfld, pmsk )   RESULT ( p_fval )
646      !!----------------------------------------------------------------------
647      !!                    ***  ROUTINE ptr_sjk  ***
648      !!
649      !! ** Purpose :   i-sum computation of an array
650      !!
651      !! ** Method  : - i-sum of field using the interior 2D vmask (pmsk).
652      !!
653      !! ** Action  : - p_fval: i-sum of masked field
654      !!----------------------------------------------------------------------
655      !!
656      IMPLICIT none
657      REAL(wp) , INTENT(in), DIMENSION(jpi,jpj,jpk)           ::   pfld   ! input field to be summed
658      REAL(wp) , INTENT(in), DIMENSION(jpi,jpj)    , OPTIONAL ::   pmsk   ! Optional 2D basin mask
659      !!
660      INTEGER                           :: ji, jj, jk ! dummy loop arguments
661      REAL(wp), POINTER, DIMENSION(:,:) :: p_fval     ! return function value
662#if defined key_mpp_mpi
663      INTEGER, DIMENSION(1) ::   ish
664      INTEGER, DIMENSION(2) ::   ish2
665      INTEGER               ::   ijpjjpk
666      REAL(wp), DIMENSION(jpj*jpk) ::   zwork    ! mask flux array at V-point
667#endif
668      !!--------------------------------------------------------------------
669      !
670      p_fval => p_fval2d
671
672      p_fval(:,:) = 0._wp
673      !
674      IF( PRESENT( pmsk ) ) THEN
675         DO jk = 1, jpkm1
676            DO jj = 2, jpjm1
677!!gm here, use of tmask_i  ==> no need of loop over nldi, nlei....
678               DO ji =  nldi, nlei   ! No vector optimisation here. Better use a mask ?
679                  p_fval(jj,jk) = p_fval(jj,jk) + pfld(ji,jj,jk) * pmsk(ji,jj)
680               END DO
681            END DO
682         END DO
683      ELSE
684         DO jk = 1, jpkm1
685            DO jj = 2, jpjm1
686               DO ji =  nldi, nlei   ! No vector optimisation here. Better use a mask ?
687                  p_fval(jj,jk) = p_fval(jj,jk) + pfld(ji,jj,jk) * tmask_i(ji,jj)
688               END DO
689            END DO
690         END DO
691      END IF
692      !
693#if defined key_mpp_mpi
694      ijpjjpk = jpj*jpk
695      ish(1) = ijpjjpk  ;   ish2(1) = jpj   ;   ish2(2) = jpk
696      zwork(1:ijpjjpk) = RESHAPE( p_fval, ish )
697      CALL mpp_sum( 'diaptr', zwork, ijpjjpk, ncomm_znl )
698      p_fval(:,:) = RESHAPE( zwork, ish2 )
699#endif
700      !
701   END FUNCTION ptr_sjk
702
703
704   !!======================================================================
705END MODULE diaptr
Note: See TracBrowser for help on using the repository browser.