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.
trczdf.F90 in branches/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/TOP_SRC/TRP/trczdf.F90 @ 7525

Last change on this file since 7525 was 7525, checked in by mocavero, 7 years ago

changes after review
  • Property svn:keywords set to Id
File size: 8.8 KB
Line 
1MODULE trczdf
2   !!==============================================================================
3   !!                 ***  MODULE  trczdf  ***
4   !! Ocean Passive tracers : vertical diffusive trends
5   !!=====================================================================
6   !! History :  9.0  ! 2005-11 (G. Madec)  Original code
7   !!       NEMO 3.0  ! 2008-01  (C. Ethe, G. Madec)  merge TRC-TRA
8   !!----------------------------------------------------------------------
9#if defined key_top
10   !!----------------------------------------------------------------------
11   !!   'key_top'                                                TOP models
12   !!----------------------------------------------------------------------
13   !!   trc_zdf      : update the tracer trend with the lateral diffusion
14   !!   trc_zdf_ini  : initialization, namelist read, and parameters control
15   !!----------------------------------------------------------------------
16   USE trc           ! ocean passive tracers variables
17   USE oce_trc       ! ocean dynamics and active tracers
18   USE trd_oce       ! trends: ocean variables
19   USE trazdf_exp    ! vertical diffusion: explicit (tra_zdf_exp     routine)
20   USE trazdf_imp    ! vertical diffusion: implicit (tra_zdf_imp     routine)
21   USE trcldf        ! passive tracers: lateral diffusion
22   USE trdtra        ! trends manager: tracers
23   USE prtctl_trc    ! Print control
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   trc_zdf         ! called by step.F90
29   PUBLIC   trc_zdf_ini     ! called by nemogcm.F90
30   
31   !                                        !!** Vertical diffusion (nam_trczdf) **
32   LOGICAL , PUBLIC ::   ln_trczdf_exp       !: explicit vertical diffusion scheme flag
33   INTEGER , PUBLIC ::   nn_trczdf_exp       !: number of sub-time step (explicit time stepping)
34
35   INTEGER ::   nzdf = 0               ! type vertical diffusion algorithm used
36      !                                ! defined from ln_zdf...  namlist logicals)
37   REAL(wp) ::  r2dttrc   ! vertical profile time-step, = 2 rdt
38      !                   ! except at nittrc000 (=rdt) if neuler=0
39
40   !! * Substitutions
41#  include "zdfddm_substitute.h90"
42#  include "vectopt_loop_substitute.h90"
43   !!----------------------------------------------------------------------
44   !! NEMO/TOP 3.7 , NEMO Consortium (2015)
45   !! $Id$
46   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
47   !!----------------------------------------------------------------------
48CONTAINS
49
50   SUBROUTINE trc_zdf( kt )
51      !!----------------------------------------------------------------------
52      !!                  ***  ROUTINE trc_zdf  ***
53      !!
54      !! ** Purpose :   compute the vertical ocean tracer physics.
55      !!---------------------------------------------------------------------
56      INTEGER, INTENT( in ) ::  kt      ! ocean time-step index
57      !
58      INTEGER               ::  jk, jn, jj, ji
59      CHARACTER (len=22)    :: charout
60      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::   ztrtrd   ! 4D workspace
61      !!---------------------------------------------------------------------
62      !
63      IF( nn_timing == 1 )  CALL timing_start('trc_zdf')
64      !
65      IF( ( neuler == 0 .AND. kt == nittrc000 ) .OR. ln_top_euler ) THEN     ! at nittrc000
66         r2dttrc =  rdttrc           ! = rdttrc (use or restarting with Euler time stepping)
67      ELSEIF( kt <= nittrc000 + nn_dttrc ) THEN          ! at nittrc000 or nittrc000+1
68         r2dttrc = 2. * rdttrc       ! = 2 rdttrc (leapfrog)
69      ENDIF
70
71      IF( l_trdtrc )  THEN
72         CALL wrk_alloc( jpi, jpj, jpk, jptra, ztrtrd )
73!$OMP PARALLEL DO schedule(static) private(jn,jk,jj,ji)
74         DO jn = 1, jptra
75            DO jk = 1, jpk
76               DO jj = 1, jpj
77                  DO ji = 1, jpi
78                     ztrtrd(ji,jj,jk,jn)  = tra(ji,jj,jk,jn)
79                  END DO
80               END DO
81            END DO
82         END DO
83      ENDIF
84
85      SELECT CASE ( nzdf )                       ! compute lateral mixing trend and add it to the general trend
86      CASE ( 0 ) ;  CALL tra_zdf_exp( kt, nittrc000, 'TRC', r2dttrc, nn_trczdf_exp, trb, tra, jptra )    !   explicit scheme
87      CASE ( 1 ) ;  CALL tra_zdf_imp( kt, nittrc000, 'TRC', r2dttrc,                trb, tra, jptra )    !   implicit scheme         
88      END SELECT
89
90      IF( l_trdtrc )   THEN                      ! save the vertical diffusive trends for further diagnostics
91         DO jn = 1, jptra
92!$OMP PARALLEL DO schedule(static) private(jk,jj,ji)
93            DO jk = 1, jpkm1
94               DO jj = 1, jpj
95                  DO ji = 1, jpi
96                     ztrtrd(ji,jj,jk,jn) = ( ( tra(ji,jj,jk,jn) - trb(ji,jj,jk,jn) ) / r2dttrc ) - ztrtrd(ji,jj,jk,jn)
97                  END DO
98               END DO
99            END DO
100            CALL trd_tra( kt, 'TRC', jn, jptra_zdf, ztrtrd(:,:,:,jn) )
101         END DO
102         CALL wrk_dealloc( jpi, jpj, jpk, jptra, ztrtrd )
103      ENDIF
104      !                                          ! print mean trends (used for debugging)
105      IF( ln_ctl )   THEN
106         WRITE(charout, FMT="('zdf ')") ;  CALL prt_ctl_trc_info(charout)
107                                           CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
108      END IF
109      !
110      IF( nn_timing == 1 )  CALL timing_stop('trc_zdf')
111      !
112   END SUBROUTINE trc_zdf
113
114
115   SUBROUTINE trc_zdf_ini
116      !!----------------------------------------------------------------------
117      !!                 ***  ROUTINE trc_zdf_ini  ***
118      !!
119      !! ** Purpose :   Choose the vertical mixing scheme
120      !!
121      !! ** Method  :   Set nzdf from ln_zdfexp
122      !!      nzdf = 0   explicit (time-splitting) scheme (ln_trczdf_exp=T)
123      !!           = 1   implicit (euler backward) scheme (ln_trczdf_exp=F)
124      !!      NB: The implicit scheme is required when using :
125      !!             - rotated lateral mixing operator
126      !!             - TKE, GLS vertical mixing scheme
127      !!----------------------------------------------------------------------
128      INTEGER ::  ios                 ! Local integer output status for namelist read
129      !!
130      NAMELIST/namtrc_zdf/ ln_trczdf_exp  , nn_trczdf_exp
131      !!----------------------------------------------------------------------
132      !
133      REWIND( numnat_ref )             ! namtrc_zdf in reference namelist
134      READ  ( numnat_ref, namtrc_zdf, IOSTAT = ios, ERR = 905)
135905   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_zdf in reference namelist', lwp )
136      !
137      REWIND( numnat_cfg )             ! namtrc_zdf in configuration namelist
138      READ  ( numnat_cfg, namtrc_zdf, IOSTAT = ios, ERR = 906 )
139906   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_zdf in configuration namelist', lwp )
140      IF(lwm) WRITE ( numont, namtrc_zdf )
141      !
142      IF(lwp) THEN                     ! Control print
143         WRITE(numout,*)
144         WRITE(numout,*) '   Namelist namtrc_zdf : set vertical diffusion  parameters'
145         WRITE(numout,*) '      time splitting / backward scheme ln_trczdf_exp = ', ln_trczdf_exp
146         WRITE(numout,*) '      number of time step              nn_trczdf_exp = ', nn_trczdf_exp
147      ENDIF
148
149      !                                ! Define the vertical tracer physics scheme
150      IF( ln_trczdf_exp ) THEN   ;   nzdf = 0     ! explicit scheme
151      ELSE                       ;   nzdf = 1     ! implicit scheme
152      ENDIF
153
154      !                                ! Force implicit schemes
155      IF( ln_trcldf_iso              )   nzdf = 1      ! iso-neutral lateral physics
156      IF( ln_trcldf_hor .AND. ln_sco )   nzdf = 1      ! horizontal lateral physics in s-coordinate
157#if defined key_zdftke || defined key_zdfgls 
158                                         nzdf = 1      ! TKE or GLS physics       
159#endif
160      IF( ln_trczdf_exp .AND. nzdf == 1 )  & 
161         CALL ctl_stop( 'trc_zdf : If using the rotated lateral mixing operator or TKE, GLS vertical scheme ', &
162            &           '          the implicit scheme is required, set ln_trczdf_exp = .false.' )
163
164      IF(lwp) THEN
165         WRITE(numout,*)
166         WRITE(numout,*) 'trc:zdf_ctl : vertical passive tracer physics scheme'
167         WRITE(numout,*) '~~~~~~~~~~~'
168         IF( nzdf ==  0 )   WRITE(numout,*) '              Explicit time-splitting scheme'
169         IF( nzdf ==  1 )   WRITE(numout,*) '              Implicit (euler backward) scheme'
170      ENDIF
171      !
172   END SUBROUTINE trc_zdf_ini
173   
174#else
175   !!----------------------------------------------------------------------
176   !!   Default option                                         Empty module
177   !!----------------------------------------------------------------------
178CONTAINS
179   SUBROUTINE trc_zdf( kt )
180      INTEGER, INTENT(in) :: kt 
181      WRITE(*,*) 'trc_zdf: You should not have seen this print! error?', kt
182   END SUBROUTINE trc_zdf
183#endif
184   !!==============================================================================
185END MODULE trczdf
Note: See TracBrowser for help on using the repository browser.