source: branches/2017/dev_r7881_HPC09_ZDF/NEMOGCM/NEMO/TOP_SRC/TRP/trczdf.F90 @ 7931

Last change on this file since 7931 was 7931, checked in by gm, 4 years ago

#1880 (HPC-09): remove key_zdfddm + phasing with last changes of HPC08 branch

  • Property svn:keywords set to Id
File size: 7.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   !! * Substitutions
38#  include "vectopt_loop_substitute.h90"
39   !!----------------------------------------------------------------------
40   !! NEMO/TOP 3.7 , NEMO Consortium (2015)
41   !! $Id$
42   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
43   !!----------------------------------------------------------------------
44CONTAINS
45
46   SUBROUTINE trc_zdf( kt )
47      !!----------------------------------------------------------------------
48      !!                  ***  ROUTINE trc_zdf  ***
49      !!
50      !! ** Purpose :   compute the vertical ocean tracer physics.
51      !!---------------------------------------------------------------------
52      INTEGER, INTENT( in ) ::  kt      ! ocean time-step index
53      !
54      INTEGER               ::  jk, jn
55      CHARACTER (len=22)    :: charout
56      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::   ztrtrd   ! 4D workspace
57      !!---------------------------------------------------------------------
58      !
59      IF( nn_timing == 1 )  CALL timing_start('trc_zdf')
60      !
61      IF( l_trdtrc )  THEN
62         CALL wrk_alloc( jpi, jpj, jpk, jptra, ztrtrd )
63         ztrtrd(:,:,:,:)  = tra(:,:,:,:)
64      ENDIF
65
66      SELECT CASE ( nzdf )                       ! compute lateral mixing trend and add it to the general trend
67      CASE ( 0 ) ;  CALL tra_zdf_exp( kt, nittrc000, 'TRC', r2dttrc, nn_trczdf_exp, trb, tra, jptra )    !   explicit scheme
68      CASE ( 1 ) ;  CALL tra_zdf_imp( kt, nittrc000, 'TRC', r2dttrc,                trb, tra, jptra )    !   implicit scheme         
69      END SELECT
70
71      IF( l_trdtrc )   THEN                      ! save the vertical diffusive trends for further diagnostics
72         DO jn = 1, jptra
73            DO jk = 1, jpkm1
74               ztrtrd(:,:,jk,jn) = ( ( tra(:,:,jk,jn) - trb(:,:,jk,jn) ) / r2dttrc ) - ztrtrd(:,:,jk,jn)
75            END DO
76            CALL trd_tra( kt, 'TRC', jn, jptra_zdf, ztrtrd(:,:,:,jn) )
77         END DO
78         CALL wrk_dealloc( jpi, jpj, jpk, jptra, ztrtrd )
79      ENDIF
80      !                                          ! print mean trends (used for debugging)
81      IF( ln_ctl )   THEN
82         WRITE(charout, FMT="('zdf ')") ;  CALL prt_ctl_trc_info(charout)
83                                           CALL prt_ctl_trc( tab4d=tra, mask=tmask, clinfo=ctrcnm, clinfo2='trd' )
84      END IF
85      !
86      IF( nn_timing == 1 )  CALL timing_stop('trc_zdf')
87      !
88   END SUBROUTINE trc_zdf
89
90
91   SUBROUTINE trc_zdf_ini
92      !!----------------------------------------------------------------------
93      !!                 ***  ROUTINE trc_zdf_ini  ***
94      !!
95      !! ** Purpose :   Choose the vertical mixing scheme
96      !!
97      !! ** Method  :   Set nzdf from ln_zdfexp
98      !!      nzdf = 0   explicit (time-splitting) scheme (ln_trczdf_exp=T)
99      !!           = 1   implicit (euler backward) scheme (ln_trczdf_exp=F)
100      !!      NB: The implicit scheme is required when using :
101      !!             - rotated lateral mixing operator
102      !!             - TKE, GLS vertical mixing scheme
103      !!----------------------------------------------------------------------
104      INTEGER ::  ios                 ! Local integer output status for namelist read
105      !!
106      NAMELIST/namtrc_zdf/ ln_trczdf_exp  , nn_trczdf_exp
107      !!----------------------------------------------------------------------
108      !
109      REWIND( numnat_ref )             ! namtrc_zdf in reference namelist
110      READ  ( numnat_ref, namtrc_zdf, IOSTAT = ios, ERR = 905)
111905   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_zdf in reference namelist', lwp )
112      !
113      REWIND( numnat_cfg )             ! namtrc_zdf in configuration namelist
114      READ  ( numnat_cfg, namtrc_zdf, IOSTAT = ios, ERR = 906 )
115906   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_zdf in configuration namelist', lwp )
116      IF(lwm) WRITE ( numont, namtrc_zdf )
117      !
118      IF(lwp) THEN                     ! Control print
119         WRITE(numout,*)
120         WRITE(numout,*) '   Namelist namtrc_zdf : set vertical diffusion  parameters'
121         WRITE(numout,*) '      time splitting / backward scheme ln_trczdf_exp = ', ln_trczdf_exp
122         WRITE(numout,*) '      number of time step              nn_trczdf_exp = ', nn_trczdf_exp
123      ENDIF
124
125      !                                ! Define the vertical tracer physics scheme
126      IF( ln_trczdf_exp ) THEN   ;   nzdf = 0     ! explicit scheme
127      ELSE                       ;   nzdf = 1     ! implicit scheme
128      ENDIF
129
130      !                                ! Force implicit schemes
131      IF( ln_trcldf_iso              )   nzdf = 1      ! iso-neutral lateral physics
132      IF( ln_trcldf_hor .AND. ln_sco )   nzdf = 1      ! horizontal lateral physics in s-coordinate
133#if defined key_zdftke || defined key_zdfgls 
134                                         nzdf = 1      ! TKE or GLS physics       
135#endif
136      IF( ln_trczdf_exp .AND. nzdf == 1 )  & 
137         CALL ctl_stop( 'trc_zdf : If using the rotated lateral mixing operator or TKE, GLS vertical scheme ', &
138            &           '          the implicit scheme is required, set ln_trczdf_exp = .false.' )
139
140      IF(lwp) THEN
141         WRITE(numout,*)
142         WRITE(numout,*) 'trc:zdf_ctl : vertical passive tracer physics scheme'
143         WRITE(numout,*) '~~~~~~~~~~~'
144         IF( nzdf ==  0 )   WRITE(numout,*) '              Explicit time-splitting scheme'
145         IF( nzdf ==  1 )   WRITE(numout,*) '              Implicit (euler backward) scheme'
146      ENDIF
147      !
148   END SUBROUTINE trc_zdf_ini
149   
150#else
151   !!----------------------------------------------------------------------
152   !!   Default option                                         Empty module
153   !!----------------------------------------------------------------------
154CONTAINS
155   SUBROUTINE trc_zdf( kt )
156      INTEGER, INTENT(in) :: kt 
157      WRITE(*,*) 'trc_zdf: You should not have seen this print! error?', kt
158   END SUBROUTINE trc_zdf
159#endif
160   !!==============================================================================
161END MODULE trczdf
Note: See TracBrowser for help on using the repository browser.