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.
trazdf.F90 in branches/UKMO/r5936_CO6_CO5_shelfdiagnostic/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/UKMO/r5936_CO6_CO5_shelfdiagnostic/NEMOGCM/NEMO/OPA_SRC/TRA/trazdf.F90 @ 7113

Last change on this file since 7113 was 7113, checked in by jcastill, 7 years ago

Remove again the svn keywords, as it did not work before

File size: 7.3 KB
Line 
1MODULE trazdf
2   !!==============================================================================
3   !!                 ***  MODULE  trazdf  ***
4   !! Ocean active tracers:  vertical component of the tracer mixing trend
5   !!==============================================================================
6   !! History :  1.0  ! 2005-11  (G. Madec)  Original code
7   !!            3.0  ! 2008-01  (C. Ethe, G. Madec)  merge TRC-TRA
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   tra_zdf      : Update the tracer trend with the vertical diffusion
12   !!   tra_zdf_init : initialisation of the computation
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and tracers variables
15   USE dom_oce         ! ocean space and time domain variables
16   USE domvvl          ! variable volume
17   USE phycst          ! physical constant
18   USE zdf_oce         ! ocean vertical physics variables
19   USE sbc_oce         ! surface boundary condition: ocean
20   !
21   USE ldftra          ! lateral diffusion: eddy diffusivity
22   USE ldfslp          ! lateral diffusion: iso-neutral slope
23   USE trazdf_exp      ! vertical diffusion: explicit (tra_zdf_exp     routine)
24   USE trazdf_imp      ! vertical diffusion: implicit (tra_zdf_imp     routine)
25   !
26   USE trd_oce         ! trends: ocean variables
27   USE trdtra          ! trends manager: tracers
28   !
29   USE in_out_manager  ! I/O manager
30   USE prtctl          ! Print control
31   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
32   USE lib_mpp         ! MPP library
33   USE wrk_nemo        ! Memory allocation
34   USE timing          ! Timing
35
36   IMPLICIT NONE
37   PRIVATE
38
39   PUBLIC   tra_zdf        ! routine called by step.F90
40   PUBLIC   tra_zdf_init   ! routine called by nemogcm.F90
41
42   INTEGER ::   nzdf = 0   ! type vertical diffusion algorithm used (defined from ln_zdf...  namlist logicals)
43
44   !! * Substitutions
45#  include "domzgr_substitute.h90"
46#  include "zdfddm_substitute.h90"
47#  include "vectopt_loop_substitute.h90"
48   !!----------------------------------------------------------------------
49   !! NEMO/OPA 3.7 , NEMO Consortium (2015)
50   !! $Id$
51   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54
55   SUBROUTINE tra_zdf( kt )
56      !!----------------------------------------------------------------------
57      !!                  ***  ROUTINE tra_zdf  ***
58      !!
59      !! ** Purpose :   compute the vertical ocean tracer physics.
60      !!---------------------------------------------------------------------
61      INTEGER, INTENT( in ) ::   kt      ! ocean time-step index
62      !!
63      INTEGER  ::   jk                   ! Dummy loop indices
64      REAL(wp), POINTER, DIMENSION(:,:,:) ::   ztrdt, ztrds   ! 3D workspace
65      !!---------------------------------------------------------------------
66      !
67      IF( nn_timing == 1 )  CALL timing_start('tra_zdf')
68      !
69      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
70         r2dtra(:) =  rdttra(:)                          ! = rdtra (restarting with Euler time stepping)
71      ELSEIF( kt <= nit000 + 1) THEN                ! at nit000 or nit000+1
72         r2dtra(:) = 2. * rdttra(:)                      ! = 2 rdttra (leapfrog)
73      ENDIF
74
75      IF( l_trdtra )   THEN                    !* Save ta and sa trends
76         CALL wrk_alloc( jpi, jpj, jpk, ztrdt, ztrds )
77         ztrdt(:,:,:) = tsa(:,:,:,jp_tem)
78         ztrds(:,:,:) = tsa(:,:,:,jp_sal)
79      ENDIF
80
81      SELECT CASE ( nzdf )                       ! compute lateral mixing trend and add it to the general trend
82      CASE ( 0 )    ;    CALL tra_zdf_exp( kt, nit000, 'TRA', r2dtra, nn_zdfexp, tsb, tsa, jpts )  !   explicit scheme
83      CASE ( 1 )    ;    CALL tra_zdf_imp( kt, nit000, 'TRA', r2dtra,            tsb, tsa, jpts )  !   implicit scheme
84      END SELECT
85!!gm WHY here !   and I don't like that !
86      ! DRAKKAR SSS control {
87      ! JMM avoid negative salinities near river outlet ! Ugly fix
88      ! JMM : restore negative salinities to small salinities:
89      WHERE ( tsa(:,:,:,jp_sal) < 0._wp )   tsa(:,:,:,jp_sal) = 0.1_wp
90!!gm
91
92      IF( l_trdtra )   THEN                      ! save the vertical diffusive trends for further diagnostics
93         DO jk = 1, jpkm1
94            ztrdt(:,:,jk) = ( ( tsa(:,:,jk,jp_tem) - tsb(:,:,jk,jp_tem) ) / r2dtra(jk) ) - ztrdt(:,:,jk)
95            ztrds(:,:,jk) = ( ( tsa(:,:,jk,jp_sal) - tsb(:,:,jk,jp_sal) ) / r2dtra(jk) ) - ztrds(:,:,jk)
96         END DO
97!!gm this should be moved in trdtra.F90 and done on all trends
98         CALL lbc_lnk( ztrdt, 'T', 1. )
99         CALL lbc_lnk( ztrds, 'T', 1. )
100!!gm
101         CALL trd_tra( kt, 'TRA', jp_tem, jptra_zdf, ztrdt )
102         CALL trd_tra( kt, 'TRA', jp_sal, jptra_zdf, ztrds )
103         CALL wrk_dealloc( jpi, jpj, jpk, ztrdt, ztrds )
104      ENDIF
105
106      !                                          ! print mean trends (used for debugging)
107      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' zdf  - Ta: ', mask1=tmask,               &
108         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
109      !
110      IF( nn_timing == 1 )  CALL timing_stop('tra_zdf')
111      !
112   END SUBROUTINE tra_zdf
113
114
115   SUBROUTINE tra_zdf_init
116      !!----------------------------------------------------------------------
117      !!                 ***  ROUTINE tra_zdf_init  ***
118      !!
119      !! ** Purpose :   Choose the vertical mixing scheme
120      !!
121      !! ** Method  :   Set nzdf from ln_zdfexp
122      !!      nzdf = 0   explicit (time-splitting) scheme (ln_zdfexp=T)
123      !!           = 1   implicit (euler backward) scheme (ln_zdfexp=F)
124      !!      NB: rotation of lateral mixing operator or TKE & GLS schemes,
125      !!          an implicit scheme is required.
126      !!----------------------------------------------------------------------
127      USE zdftke
128      USE zdfgls
129      !!----------------------------------------------------------------------
130
131      ! Choice from ln_zdfexp already read in namelist in zdfini module
132      IF( ln_zdfexp ) THEN   ;   nzdf = 0           ! use explicit scheme
133      ELSE                   ;   nzdf = 1           ! use implicit scheme
134      ENDIF
135
136      ! Force implicit schemes
137      IF( lk_zdftke .OR. lk_zdfgls   )   nzdf = 1   ! TKE, or GLS physics
138      IF( ln_traldf_iso              )   nzdf = 1   ! iso-neutral lateral physics
139      IF( ln_traldf_hor .AND. ln_sco )   nzdf = 1   ! horizontal lateral physics in s-coordinate
140      IF( ln_zdfexp .AND. nzdf == 1 )   CALL ctl_stop( 'tra_zdf : If using the rotation of lateral mixing operator',   &
141            &                         ' GLS or TKE scheme, the implicit scheme is required, set ln_zdfexp = .false.' )
142
143      IF(lwp) THEN
144         WRITE(numout,*)
145         WRITE(numout,*) 'tra_zdf_init : vertical tracer physics scheme'
146         WRITE(numout,*) '~~~~~~~~~~~'
147         IF( nzdf ==  0 )   WRITE(numout,*) '              Explicit time-splitting scheme'
148         IF( nzdf ==  1 )   WRITE(numout,*) '              Implicit (euler backward) scheme'
149      ENDIF
150      !
151   END SUBROUTINE tra_zdf_init
152
153   !!==============================================================================
154END MODULE trazdf
Note: See TracBrowser for help on using the repository browser.