[3] | 1 | MODULE 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 |
---|
[14072] | 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 |
---|
[4990] | 26 | USE trd_oce ! trends: ocean variables |
---|
[14072] | 27 | USE trdtra ! trends manager: tracers |
---|
[2528] | 28 | USE zdf_oce ! ocean: vertical physics |
---|
| 29 | USE phycst ! physical constants |
---|
[3294] | 30 | USE dtatsd ! data: temperature & salinity |
---|
[2528] | 31 | USE zdfmxl ! vertical physics: mixed layer depth |
---|
[6140] | 32 | ! |
---|
[2528] | 33 | USE in_out_manager ! I/O manager |
---|
[9019] | 34 | USE iom ! XIOS |
---|
[2528] | 35 | USE lib_mpp ! MPP library |
---|
| 36 | USE prtctl ! Print control |
---|
[3294] | 37 | USE timing ! Timing |
---|
[3] | 38 | |
---|
| 39 | IMPLICIT NONE |
---|
| 40 | PRIVATE |
---|
| 41 | |
---|
[6140] | 42 | PUBLIC tra_dmp ! called by step.F90 |
---|
| 43 | PUBLIC tra_dmp_init ! called by nemogcm.F90 |
---|
[3] | 44 | |
---|
[5836] | 45 | ! !!* Namelist namtra_dmp : T & S newtonian damping * |
---|
| 46 | LOGICAL , PUBLIC :: ln_tradmp !: internal damping flag |
---|
| 47 | INTEGER , PUBLIC :: nn_zdmp !: = 0/1/2 flag for damping in the mixed layer |
---|
| 48 | CHARACTER(LEN=200) , PUBLIC :: cn_resto !: name of netcdf file containing restoration coefficient field |
---|
[5102] | 49 | ! |
---|
[2715] | 50 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: resto !: restoring coeff. on T and S (s-1) |
---|
[3] | 51 | |
---|
| 52 | !! * Substitutions |
---|
[12377] | 53 | # include "do_loop_substitute.h90" |
---|
[14982] | 54 | # include "domzgr_substitute.h90" |
---|
[3] | 55 | !!---------------------------------------------------------------------- |
---|
[9598] | 56 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[14072] | 57 | !! $Id$ |
---|
[10068] | 58 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3] | 59 | !!---------------------------------------------------------------------- |
---|
| 60 | CONTAINS |
---|
| 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 | ! |
---|
[10425] | 68 | CALL mpp_sum ( 'tradmp', tra_dmp_alloc ) |
---|
[2715] | 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 | |
---|
[12377] | 74 | SUBROUTINE tra_dmp( kt, Kbb, Kmm, pts, Krhs ) |
---|
[3] | 75 | !!---------------------------------------------------------------------- |
---|
| 76 | !! *** ROUTINE tra_dmp *** |
---|
[14072] | 77 | !! |
---|
[3] | 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 | !! |
---|
[14072] | 82 | !! ** Method : Newtonian damping towards t_dta and s_dta computed |
---|
[3] | 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 | !!---------------------------------------------------------------------- |
---|
[12377] | 92 | INTEGER, INTENT(in ) :: kt ! ocean time-step index |
---|
| 93 | INTEGER, INTENT(in ) :: Kbb, Kmm, Krhs ! time level indices |
---|
| 94 | REAL(wp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) :: pts ! active tracers and RHS of tracer equation |
---|
[3294] | 95 | ! |
---|
[5836] | 96 | INTEGER :: ji, jj, jk, jn ! dummy loop indices |
---|
[13982] | 97 | REAL(wp), DIMENSION(A2D(nn_hls),jpk,jpts) :: zts_dta |
---|
[14982] | 98 | REAL(wp), DIMENSION(:,:,:) , ALLOCATABLE :: zwrk |
---|
[9019] | 99 | REAL(wp), DIMENSION(:,:,:,:), ALLOCATABLE :: ztrdts |
---|
[3] | 100 | !!---------------------------------------------------------------------- |
---|
[503] | 101 | ! |
---|
[9019] | 102 | IF( ln_timing ) CALL timing_start('tra_dmp') |
---|
[3294] | 103 | ! |
---|
[14718] | 104 | IF( l_trdtra .OR. iom_use('hflx_dmp_cea') .OR. iom_use('sflx_dmp_cea') ) THEN !* Save ta and sa trends |
---|
[14982] | 105 | ALLOCATE( ztrdts(A2D(nn_hls),jpk,jpts) ) |
---|
| 106 | DO jn = 1, jpts |
---|
| 107 | DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpk ) |
---|
| 108 | ztrdts(ji,jj,jk,jn) = pts(ji,jj,jk,jn,Krhs) |
---|
| 109 | END_3D |
---|
| 110 | END DO |
---|
[5836] | 111 | ENDIF |
---|
| 112 | ! !== input T-S data at kt ==! |
---|
[3294] | 113 | CALL dta_tsd( kt, zts_dta ) ! read and interpolates T-S data at kt |
---|
| 114 | ! |
---|
[5836] | 115 | SELECT CASE ( nn_zdmp ) !== type of damping ==! |
---|
[2528] | 116 | ! |
---|
[5836] | 117 | CASE( 0 ) !* newtonian damping throughout the water column *! |
---|
| 118 | DO jn = 1, jpts |
---|
[13295] | 119 | DO_3D( 0, 0, 0, 0, 1, jpkm1 ) |
---|
[12377] | 120 | pts(ji,jj,jk,jn,Krhs) = pts(ji,jj,jk,jn,Krhs) & |
---|
| 121 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jn) - pts(ji,jj,jk,jn,Kbb) ) |
---|
| 122 | END_3D |
---|
[3] | 123 | END DO |
---|
[503] | 124 | ! |
---|
[5836] | 125 | CASE ( 1 ) !* no damping in the turbocline (avt > 5 cm2/s) *! |
---|
[13295] | 126 | DO_3D( 0, 0, 0, 0, 1, jpkm1 ) |
---|
[12377] | 127 | IF( avt(ji,jj,jk) <= avt_c ) THEN |
---|
| 128 | pts(ji,jj,jk,jp_tem,Krhs) = pts(ji,jj,jk,jp_tem,Krhs) & |
---|
| 129 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_tem) - pts(ji,jj,jk,jp_tem,Kbb) ) |
---|
| 130 | pts(ji,jj,jk,jp_sal,Krhs) = pts(ji,jj,jk,jp_sal,Krhs) & |
---|
| 131 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_sal) - pts(ji,jj,jk,jp_sal,Kbb) ) |
---|
| 132 | ENDIF |
---|
| 133 | END_3D |
---|
[503] | 134 | ! |
---|
[5836] | 135 | CASE ( 2 ) !* no damping in the mixed layer *! |
---|
[13295] | 136 | DO_3D( 0, 0, 0, 0, 1, jpkm1 ) |
---|
[12377] | 137 | IF( gdept(ji,jj,jk,Kmm) >= hmlp (ji,jj) ) THEN |
---|
| 138 | pts(ji,jj,jk,jp_tem,Krhs) = pts(ji,jj,jk,jp_tem,Krhs) & |
---|
| 139 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_tem) - pts(ji,jj,jk,jp_tem,Kbb) ) |
---|
| 140 | pts(ji,jj,jk,jp_sal,Krhs) = pts(ji,jj,jk,jp_sal,Krhs) & |
---|
| 141 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_sal) - pts(ji,jj,jk,jp_sal,Kbb) ) |
---|
| 142 | ENDIF |
---|
| 143 | END_3D |
---|
[503] | 144 | ! |
---|
[3] | 145 | END SELECT |
---|
[2528] | 146 | ! |
---|
[14718] | 147 | ! outputs (clem trunk) |
---|
[14982] | 148 | IF( iom_use('hflx_dmp_cea') .OR. iom_use('sflx_dmp_cea') ) THEN |
---|
| 149 | ALLOCATE( zwrk(A2D(nn_hls),jpk) ) ! Needed to handle expressions containing e3t when using key_qco or key_linssh |
---|
| 150 | zwrk(:,:,:) = 0._wp |
---|
| 151 | |
---|
| 152 | IF( iom_use('hflx_dmp_cea') ) THEN |
---|
| 153 | DO_3D( 0, 0, 0, 0, 1, jpk ) |
---|
| 154 | zwrk(ji,jj,jk) = ( pts(ji,jj,jk,jp_tem,Krhs) - ztrdts(ji,jj,jk,jp_tem) ) * e3t(ji,jj,jk,Kmm) |
---|
| 155 | END_3D |
---|
| 156 | CALL iom_put('hflx_dmp_cea', SUM( zwrk(:,:,:), dim=3 ) * rcp * rho0 ) ! W/m2 |
---|
| 157 | ENDIF |
---|
| 158 | IF( iom_use('sflx_dmp_cea') ) THEN |
---|
| 159 | DO_3D( 0, 0, 0, 0, 1, jpk ) |
---|
| 160 | zwrk(ji,jj,jk) = ( pts(ji,jj,jk,jp_sal,Krhs) - ztrdts(ji,jj,jk,jp_sal) ) * e3t(ji,jj,jk,Kmm) |
---|
| 161 | END_3D |
---|
| 162 | CALL iom_put('sflx_dmp_cea', SUM( zwrk(:,:,:), dim=3 ) * rho0 ) ! g/m2/s |
---|
| 163 | ENDIF |
---|
| 164 | |
---|
| 165 | DEALLOCATE( zwrk ) |
---|
| 166 | ENDIF |
---|
[14718] | 167 | ! |
---|
[1601] | 168 | IF( l_trdtra ) THEN ! trend diagnostic |
---|
[12377] | 169 | ztrdts(:,:,:,:) = pts(:,:,:,:,Krhs) - ztrdts(:,:,:,:) |
---|
| 170 | CALL trd_tra( kt, Kmm, Krhs, 'TRA', jp_tem, jptra_dmp, ztrdts(:,:,:,jp_tem) ) |
---|
| 171 | CALL trd_tra( kt, Kmm, Krhs, 'TRA', jp_sal, jptra_dmp, ztrdts(:,:,:,jp_sal) ) |
---|
[13982] | 172 | DEALLOCATE( ztrdts ) |
---|
[216] | 173 | ENDIF |
---|
[1601] | 174 | ! ! Control print |
---|
[12377] | 175 | IF(sn_cfctl%l_prtctl) CALL prt_ctl( tab3d_1=pts(:,:,:,jp_tem,Krhs), clinfo1=' dmp - Ta: ', mask1=tmask, & |
---|
| 176 | & tab3d_2=pts(:,:,:,jp_sal,Krhs), clinfo2= ' Sa: ', mask2=tmask, clinfo3='tra' ) |
---|
[503] | 177 | ! |
---|
[9019] | 178 | IF( ln_timing ) CALL timing_stop('tra_dmp') |
---|
[3294] | 179 | ! |
---|
[3] | 180 | END SUBROUTINE tra_dmp |
---|
| 181 | |
---|
| 182 | |
---|
| 183 | SUBROUTINE tra_dmp_init |
---|
| 184 | !!---------------------------------------------------------------------- |
---|
| 185 | !! *** ROUTINE tra_dmp_init *** |
---|
| 186 | !! |
---|
[14072] | 187 | !! ** Purpose : Initialization for the newtonian damping |
---|
| 188 | !! |
---|
[4245] | 189 | !! ** Method : read the namtra_dmp namelist and check the parameters |
---|
[3] | 190 | !!---------------------------------------------------------------------- |
---|
[14072] | 191 | INTEGER :: ios, imask ! local integers |
---|
[6140] | 192 | ! |
---|
[5102] | 193 | NAMELIST/namtra_dmp/ ln_tradmp, nn_zdmp, cn_resto |
---|
[541] | 194 | !!---------------------------------------------------------------------- |
---|
[4990] | 195 | ! |
---|
[4147] | 196 | READ ( numnam_ref, namtra_dmp, IOSTAT = ios, ERR = 901) |
---|
[11536] | 197 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_dmp in reference namelist' ) |
---|
[4990] | 198 | ! |
---|
[4147] | 199 | READ ( numnam_cfg, namtra_dmp, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 200 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtra_dmp in configuration namelist' ) |
---|
[4624] | 201 | IF(lwm) WRITE ( numond, namtra_dmp ) |
---|
[5836] | 202 | ! |
---|
| 203 | IF(lwp) THEN ! Namelist print |
---|
[3] | 204 | WRITE(numout,*) |
---|
[5102] | 205 | WRITE(numout,*) 'tra_dmp_init : T and S newtonian relaxation' |
---|
[7646] | 206 | WRITE(numout,*) '~~~~~~~~~~~~' |
---|
[5102] | 207 | WRITE(numout,*) ' Namelist namtra_dmp : set relaxation parameters' |
---|
[9168] | 208 | WRITE(numout,*) ' Apply relaxation or not ln_tradmp = ', ln_tradmp |
---|
| 209 | WRITE(numout,*) ' mixed layer damping option nn_zdmp = ', nn_zdmp |
---|
| 210 | WRITE(numout,*) ' Damping file name cn_resto = ', cn_resto |
---|
[3294] | 211 | WRITE(numout,*) |
---|
[3] | 212 | ENDIF |
---|
[5836] | 213 | ! |
---|
[9490] | 214 | IF( ln_tradmp ) THEN |
---|
[5836] | 215 | ! ! Allocate arrays |
---|
| 216 | IF( tra_dmp_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'tra_dmp_init: unable to allocate arrays' ) |
---|
[3294] | 217 | ! |
---|
[5836] | 218 | SELECT CASE (nn_zdmp) ! Check values of nn_zdmp |
---|
| 219 | CASE ( 0 ) ; IF(lwp) WRITE(numout,*) ' tracer damping as specified by mask' |
---|
| 220 | CASE ( 1 ) ; IF(lwp) WRITE(numout,*) ' no tracer damping in the mixing layer (kz > 5 cm2/s)' |
---|
| 221 | CASE ( 2 ) ; IF(lwp) WRITE(numout,*) ' no tracer damping in the mixed layer' |
---|
| 222 | CASE DEFAULT |
---|
| 223 | CALL ctl_stop('tra_dmp_init : wrong value of nn_zdmp') |
---|
[3294] | 224 | END SELECT |
---|
[5836] | 225 | ! |
---|
| 226 | !!TG: Initialisation of dtatsd - Would it be better to have dmpdta routine |
---|
| 227 | ! so can damp to something other than intitial conditions files? |
---|
| 228 | !!gm: In principle yes. Nevertheless, we can't anticipate demands that have never been formulated. |
---|
[9490] | 229 | IF( .NOT.ln_tsd_dmp ) THEN |
---|
[5836] | 230 | IF(lwp) WRITE(numout,*) |
---|
[9490] | 231 | IF(lwp) WRITE(numout, *) ' read T-S data not initialized, we force ln_tsd_dmp=T' |
---|
[3294] | 232 | CALL dta_tsd_init( ld_tradmp=ln_tradmp ) ! forces the initialisation of T-S data |
---|
| 233 | ENDIF |
---|
[5836] | 234 | ! ! Read in mask from file |
---|
[5102] | 235 | CALL iom_open ( cn_resto, imask) |
---|
[13286] | 236 | CALL iom_get ( imask, jpdom_auto, 'resto', resto ) |
---|
[5102] | 237 | CALL iom_close( imask ) |
---|
[5836] | 238 | ENDIF |
---|
| 239 | ! |
---|
[5102] | 240 | END SUBROUTINE tra_dmp_init |
---|
[3] | 241 | |
---|
[6140] | 242 | !!====================================================================== |
---|
[3] | 243 | END MODULE tradmp |
---|