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/2015/dev_r5836_NOC3_vvl_by_default/NEMOGCM/NEMO/TOP_SRC/TRP – NEMO

source: branches/2015/dev_r5836_NOC3_vvl_by_default/NEMOGCM/NEMO/TOP_SRC/TRP/trczdf.F90 @ 5845

Last change on this file since 5845 was 5845, checked in by gm, 8 years ago

#1613: vvl by default: suppression of domzgr_substitute.h90

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