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.
tradmp.F90 in NEMO/trunk/src/OCE/TRA – NEMO

source: NEMO/trunk/src/OCE/TRA/tradmp.F90 @ 10351

Last change on this file since 10351 was 10351, checked in by mathiot, 5 years ago

fix #1685 (replace 5.e-4_wp by avt_c in dmp routine as it is computed in zdfmxl + apply test on avt instead on avs in trcdmp)

  • Property svn:keywords set to Id
File size: 11.0 KB
RevLine 
[3]1MODULE tradmp
2   !!======================================================================
3   !!                       ***  MODULE  tradmp  ***
4   !! Ocean physics: internal restoring trend on active tracers (T and S)
5   !!======================================================================
[1601]6   !! History :  OPA  ! 1991-03  (O. Marti, G. Madec)  Original code
7   !!                 ! 1992-06  (M. Imbard)  doctor norme
8   !!                 ! 1998-07  (M. Imbard, G. Madec) ORCA version
[5836]9   !!            7.0  ! 2001-02  (M. Imbard)  add distance to coast, Original code
[1601]10   !!            8.1  ! 2001-02  (G. Madec, E. Durand)  cleaning
11   !!  NEMO      1.0  ! 2002-08  (G. Madec, E. Durand)  free form + modules
12   !!            3.2  ! 2009-08  (G. Madec, C. Talandier)  DOCTOR norm for namelist parameter
[2528]13   !!            3.3  ! 2010-06  (C. Ethe, G. Madec) merge TRA-TRC
[3294]14   !!            3.4  ! 2011-04  (G. Madec, C. Ethe) Merge of dtatem and dtasal + suppression of CPP keys
[5836]15   !!            3.6  ! 2015-06  (T. Graham)  read restoring coefficient in a file
16   !!            3.7  ! 2015-10  (G. Madec)  remove useless trends arrays
[503]17   !!----------------------------------------------------------------------
[3294]18
[3]19   !!----------------------------------------------------------------------
[2715]20   !!   tra_dmp_alloc : allocate tradmp arrays
[2528]21   !!   tra_dmp       : update the tracer trend with the internal damping
22   !!   tra_dmp_init  : initialization, namlist read, parameters control
[3]23   !!----------------------------------------------------------------------
[2528]24   USE oce            ! ocean: variables
25   USE dom_oce        ! ocean: domain variables
[4245]26   USE c1d            ! 1D vertical configuration
[4990]27   USE trd_oce        ! trends: ocean variables
28   USE trdtra         ! trends manager: tracers
[2528]29   USE zdf_oce        ! ocean: vertical physics
30   USE phycst         ! physical constants
[3294]31   USE dtatsd         ! data: temperature & salinity
[2528]32   USE zdfmxl         ! vertical physics: mixed layer depth
[6140]33   !
[2528]34   USE in_out_manager ! I/O manager
[9019]35   USE iom            ! XIOS
[2528]36   USE lib_mpp        ! MPP library
37   USE prtctl         ! Print control
[3294]38   USE timing         ! Timing
[3]39
40   IMPLICIT NONE
41   PRIVATE
42
[6140]43   PUBLIC   tra_dmp        ! called by step.F90
44   PUBLIC   tra_dmp_init   ! called by nemogcm.F90
[3]45
[5836]46   !                                           !!* Namelist namtra_dmp : T & S newtonian damping *
47   LOGICAL            , PUBLIC ::   ln_tradmp   !: internal damping flag
48   INTEGER            , PUBLIC ::   nn_zdmp     !: = 0/1/2 flag for damping in the mixed layer
49   CHARACTER(LEN=200) , PUBLIC ::   cn_resto    !: name of netcdf file containing restoration coefficient field
[5102]50   !
[2715]51   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   resto    !: restoring coeff. on T and S (s-1)
[3]52
53   !! * Substitutions
54#  include "vectopt_loop_substitute.h90"
55   !!----------------------------------------------------------------------
[9598]56   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1152]57   !! $Id$
[10068]58   !! Software governed by the CeCILL license (see ./LICENSE)
[3]59   !!----------------------------------------------------------------------
60CONTAINS
61
[2715]62   INTEGER FUNCTION tra_dmp_alloc()
63      !!----------------------------------------------------------------------
[3294]64      !!                ***  FUNCTION tra_dmp_alloc  ***
[2715]65      !!----------------------------------------------------------------------
[5836]66      ALLOCATE( resto(jpi,jpj,jpk), STAT= tra_dmp_alloc )
[2715]67      !
68      IF( lk_mpp            )   CALL mpp_sum ( tra_dmp_alloc )
69      IF( tra_dmp_alloc > 0 )   CALL ctl_warn('tra_dmp_alloc: allocation of arrays failed')
[3294]70      !
[2715]71   END FUNCTION tra_dmp_alloc
72
73
[3]74   SUBROUTINE tra_dmp( kt )
75      !!----------------------------------------------------------------------
76      !!                   ***  ROUTINE tra_dmp  ***
77      !!                 
78      !! ** Purpose :   Compute the tracer trend due to a newtonian damping
79      !!      of the tracer field towards given data field and add it to the
80      !!      general tracer trends.
81      !!
82      !! ** Method  :   Newtonian damping towards t_dta and s_dta computed
83      !!      and add to the general tracer trends:
84      !!                     ta = ta + resto * (t_dta - tb)
85      !!                     sa = sa + resto * (s_dta - sb)
86      !!         The trend is computed either throughout the water column
87      !!      (nlmdmp=0) or in area of weak vertical mixing (nlmdmp=1) or
88      !!      below the well mixed layer (nlmdmp=2)
89      !!
[6140]90      !! ** Action  : - tsa: tracer trends updated with the damping trend
[503]91      !!----------------------------------------------------------------------
[5836]92      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
[3294]93      !
[5836]94      INTEGER ::   ji, jj, jk, jn   ! dummy loop indices
[9019]95      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts)     ::  zts_dta
96      REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE ::  ztrdts
[3]97      !!----------------------------------------------------------------------
[503]98      !
[9019]99      IF( ln_timing )   CALL timing_start('tra_dmp')
[3294]100      !
[5836]101      IF( l_trdtra )   THEN                    !* Save ta and sa trends
[9019]102         ALLOCATE( ztrdts(jpi,jpj,jpk,jpts) ) 
[7753]103         ztrdts(:,:,:,:) = tsa(:,:,:,:) 
[5836]104      ENDIF
105      !                           !==  input T-S data at kt  ==!
[3294]106      CALL dta_tsd( kt, zts_dta )            ! read and interpolates T-S data at kt
107      !
[5836]108      SELECT CASE ( nn_zdmp )     !==  type of damping  ==!
[2528]109      !
[5836]110      CASE( 0 )                        !*  newtonian damping throughout the water column  *!
111         DO jn = 1, jpts
112            DO jk = 1, jpkm1
113               DO jj = 2, jpjm1
114                  DO ji = fs_2, fs_jpim1   ! vector opt.
115                     tsa(ji,jj,jk,jn) = tsa(ji,jj,jk,jn) + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jn) - tsb(ji,jj,jk,jn) )
116                  END DO
[3]117               END DO
118            END DO
119         END DO
[503]120         !
[5836]121      CASE ( 1 )                       !*  no damping in the turbocline (avt > 5 cm2/s)  *!
[3]122         DO jk = 1, jpkm1
123            DO jj = 2, jpjm1
124               DO ji = fs_2, fs_jpim1   ! vector opt.
[10351]125                  IF( avt(ji,jj,jk) <= avt_c ) THEN
[5836]126                     tsa(ji,jj,jk,jp_tem) = tsa(ji,jj,jk,jp_tem)   &
127                        &                 + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_tem) - tsb(ji,jj,jk,jp_tem) )
128                     tsa(ji,jj,jk,jp_sal) = tsa(ji,jj,jk,jp_sal)   &
129                        &                 + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_sal) - tsb(ji,jj,jk,jp_sal) )
[3]130                  ENDIF
131               END DO
132            END DO
133         END DO
[503]134         !
[5836]135      CASE ( 2 )                       !*  no damping in the mixed layer   *!
[3]136         DO jk = 1, jpkm1
137            DO jj = 2, jpjm1
138               DO ji = fs_2, fs_jpim1   ! vector opt.
[6140]139                  IF( gdept_n(ji,jj,jk) >= hmlp (ji,jj) ) THEN
[5836]140                     tsa(ji,jj,jk,jp_tem) = tsa(ji,jj,jk,jp_tem)   &
141                        &                 + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_tem) - tsb(ji,jj,jk,jp_tem) )
142                     tsa(ji,jj,jk,jp_sal) = tsa(ji,jj,jk,jp_sal)   &
143                        &                 + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_sal) - tsb(ji,jj,jk,jp_sal) )
[3]144                  ENDIF
145               END DO
146            END DO
147         END DO
[503]148         !
[3]149      END SELECT
[2528]150      !
[1601]151      IF( l_trdtra )   THEN       ! trend diagnostic
[7753]152         ztrdts(:,:,:,:) = tsa(:,:,:,:) - ztrdts(:,:,:,:)
[5836]153         CALL trd_tra( kt, 'TRA', jp_tem, jptra_dmp, ztrdts(:,:,:,jp_tem) )
154         CALL trd_tra( kt, 'TRA', jp_sal, jptra_dmp, ztrdts(:,:,:,jp_sal) )
[9019]155         DEALLOCATE( ztrdts ) 
[216]156      ENDIF
[1601]157      !                           ! Control print
[2528]158      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' dmp  - Ta: ', mask1=tmask,   &
159         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
[503]160      !
[9019]161      IF( ln_timing )   CALL timing_stop('tra_dmp')
[3294]162      !
[3]163   END SUBROUTINE tra_dmp
164
165
166   SUBROUTINE tra_dmp_init
167      !!----------------------------------------------------------------------
168      !!                  ***  ROUTINE tra_dmp_init  ***
169      !!
170      !! ** Purpose :   Initialization for the newtonian damping
171      !!
[4245]172      !! ** Method  :   read the namtra_dmp namelist and check the parameters
[3]173      !!----------------------------------------------------------------------
[5836]174      INTEGER ::   ios, imask   ! local integers
[6140]175      !
[5102]176      NAMELIST/namtra_dmp/ ln_tradmp, nn_zdmp, cn_resto
[541]177      !!----------------------------------------------------------------------
[4990]178      !
[5102]179      REWIND( numnam_ref )   ! Namelist namtra_dmp in reference namelist : T & S relaxation
[4147]180      READ  ( numnam_ref, namtra_dmp, IOSTAT = ios, ERR = 901)
[9168]181901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namtra_dmp in reference namelist', lwp )
[4990]182      !
[5102]183      REWIND( numnam_cfg )   ! Namelist namtra_dmp in configuration namelist : T & S relaxation
[4147]184      READ  ( numnam_cfg, namtra_dmp, IOSTAT = ios, ERR = 902 )
[9168]185902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namtra_dmp in configuration namelist', lwp )
[4624]186      IF(lwm) WRITE ( numond, namtra_dmp )
[5836]187      !
188      IF(lwp) THEN                  ! Namelist print
[3]189         WRITE(numout,*)
[5102]190         WRITE(numout,*) 'tra_dmp_init : T and S newtonian relaxation'
[7646]191         WRITE(numout,*) '~~~~~~~~~~~~'
[5102]192         WRITE(numout,*) '   Namelist namtra_dmp : set relaxation parameters'
[9168]193         WRITE(numout,*) '      Apply relaxation   or not       ln_tradmp   = ', ln_tradmp
194         WRITE(numout,*) '         mixed layer damping option      nn_zdmp  = ', nn_zdmp
195         WRITE(numout,*) '         Damping file name               cn_resto = ', cn_resto
[3294]196         WRITE(numout,*)
[3]197      ENDIF
[5836]198      !
[9490]199      IF( ln_tradmp ) THEN
[5836]200         !                          ! Allocate arrays
201         IF( tra_dmp_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'tra_dmp_init: unable to allocate arrays' )
[3294]202         !
[5836]203         SELECT CASE (nn_zdmp)      ! Check values of nn_zdmp
204         CASE ( 0 )   ;   IF(lwp) WRITE(numout,*) '   tracer damping as specified by mask'
205         CASE ( 1 )   ;   IF(lwp) WRITE(numout,*) '   no tracer damping in the mixing layer (kz > 5 cm2/s)'
206         CASE ( 2 )   ;   IF(lwp) WRITE(numout,*) '   no tracer damping in the mixed  layer'
207         CASE DEFAULT
208            CALL ctl_stop('tra_dmp_init : wrong value of nn_zdmp')
[3294]209         END SELECT
[5836]210         !
211         !!TG: Initialisation of dtatsd - Would it be better to have dmpdta routine
212         !    so can damp to something other than intitial conditions files?
213         !!gm: In principle yes. Nevertheless, we can't anticipate demands that have never been formulated.
[9490]214         IF( .NOT.ln_tsd_dmp ) THEN
[5836]215            IF(lwp) WRITE(numout,*)
[9490]216            IF(lwp) WRITE(numout, *)  '   read T-S data not initialized, we force ln_tsd_dmp=T'
[3294]217            CALL dta_tsd_init( ld_tradmp=ln_tradmp )        ! forces the initialisation of T-S data
218         ENDIF
[5836]219         !                          ! Read in mask from file
[5102]220         CALL iom_open ( cn_resto, imask)
[5836]221         CALL iom_get  ( imask, jpdom_autoglo, 'resto', resto )
[5102]222         CALL iom_close( imask )
[5836]223      ENDIF
224      !
[5102]225   END SUBROUTINE tra_dmp_init
[3]226
[6140]227   !!======================================================================
[3]228END MODULE tradmp
Note: See TracBrowser for help on using the repository browser.