[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 |
---|
[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 |
---|
| 35 | USE lib_mpp ! MPP library |
---|
| 36 | USE prtctl ! Print control |
---|
[3294] | 37 | USE wrk_nemo ! Memory allocation |
---|
| 38 | USE timing ! Timing |
---|
[5102] | 39 | USE iom |
---|
[3] | 40 | |
---|
| 41 | IMPLICIT NONE |
---|
| 42 | PRIVATE |
---|
| 43 | |
---|
[6140] | 44 | PUBLIC tra_dmp ! called by step.F90 |
---|
| 45 | PUBLIC tra_dmp_init ! called by nemogcm.F90 |
---|
[3] | 46 | |
---|
[5836] | 47 | ! !!* Namelist namtra_dmp : T & S newtonian damping * |
---|
| 48 | LOGICAL , PUBLIC :: ln_tradmp !: internal damping flag |
---|
| 49 | INTEGER , PUBLIC :: nn_zdmp !: = 0/1/2 flag for damping in the mixed layer |
---|
| 50 | CHARACTER(LEN=200) , PUBLIC :: cn_resto !: name of netcdf file containing restoration coefficient field |
---|
[5102] | 51 | ! |
---|
[2715] | 52 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: resto !: restoring coeff. on T and S (s-1) |
---|
[3] | 53 | |
---|
| 54 | !! * Substitutions |
---|
| 55 | # include "vectopt_loop_substitute.h90" |
---|
| 56 | !!---------------------------------------------------------------------- |
---|
[2528] | 57 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[1152] | 58 | !! $Id$ |
---|
[2528] | 59 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[3] | 60 | !!---------------------------------------------------------------------- |
---|
| 61 | CONTAINS |
---|
| 62 | |
---|
[2715] | 63 | INTEGER FUNCTION tra_dmp_alloc() |
---|
| 64 | !!---------------------------------------------------------------------- |
---|
[3294] | 65 | !! *** FUNCTION tra_dmp_alloc *** |
---|
[2715] | 66 | !!---------------------------------------------------------------------- |
---|
[5836] | 67 | ALLOCATE( resto(jpi,jpj,jpk), STAT= tra_dmp_alloc ) |
---|
[2715] | 68 | ! |
---|
| 69 | IF( lk_mpp ) CALL mpp_sum ( tra_dmp_alloc ) |
---|
| 70 | IF( tra_dmp_alloc > 0 ) CALL ctl_warn('tra_dmp_alloc: allocation of arrays failed') |
---|
[3294] | 71 | ! |
---|
[2715] | 72 | END FUNCTION tra_dmp_alloc |
---|
| 73 | |
---|
| 74 | |
---|
[3] | 75 | SUBROUTINE tra_dmp( kt ) |
---|
| 76 | !!---------------------------------------------------------------------- |
---|
| 77 | !! *** ROUTINE tra_dmp *** |
---|
| 78 | !! |
---|
| 79 | !! ** Purpose : Compute the tracer trend due to a newtonian damping |
---|
| 80 | !! of the tracer field towards given data field and add it to the |
---|
| 81 | !! general tracer trends. |
---|
| 82 | !! |
---|
| 83 | !! ** Method : Newtonian damping towards t_dta and s_dta computed |
---|
| 84 | !! and add to the general tracer trends: |
---|
| 85 | !! ta = ta + resto * (t_dta - tb) |
---|
| 86 | !! sa = sa + resto * (s_dta - sb) |
---|
| 87 | !! The trend is computed either throughout the water column |
---|
| 88 | !! (nlmdmp=0) or in area of weak vertical mixing (nlmdmp=1) or |
---|
| 89 | !! below the well mixed layer (nlmdmp=2) |
---|
| 90 | !! |
---|
[6140] | 91 | !! ** Action : - tsa: tracer trends updated with the damping trend |
---|
[503] | 92 | !!---------------------------------------------------------------------- |
---|
[5836] | 93 | INTEGER, INTENT(in) :: kt ! ocean time-step index |
---|
[3294] | 94 | ! |
---|
[5836] | 95 | INTEGER :: ji, jj, jk, jn ! dummy loop indices |
---|
| 96 | REAL(wp), POINTER, DIMENSION(:,:,:,:) :: zts_dta, ztrdts |
---|
[3] | 97 | !!---------------------------------------------------------------------- |
---|
[503] | 98 | ! |
---|
[5836] | 99 | IF( nn_timing == 1 ) CALL timing_start('tra_dmp') |
---|
[3294] | 100 | ! |
---|
[5836] | 101 | CALL wrk_alloc( jpi,jpj,jpk,jpts, zts_dta ) |
---|
| 102 | IF( l_trdtra ) THEN !* Save ta and sa trends |
---|
| 103 | CALL wrk_alloc( jpi,jpj,jpk,jpts, ztrdts ) |
---|
[7753] | 104 | ztrdts(:,:,:,:) = tsa(:,:,:,:) |
---|
[5836] | 105 | ENDIF |
---|
| 106 | ! !== input T-S data at kt ==! |
---|
[3294] | 107 | CALL dta_tsd( kt, zts_dta ) ! read and interpolates T-S data at kt |
---|
| 108 | ! |
---|
[5836] | 109 | SELECT CASE ( nn_zdmp ) !== type of damping ==! |
---|
[2528] | 110 | ! |
---|
[5836] | 111 | CASE( 0 ) !* newtonian damping throughout the water column *! |
---|
| 112 | DO jn = 1, jpts |
---|
| 113 | DO jk = 1, jpkm1 |
---|
| 114 | DO jj = 2, jpjm1 |
---|
| 115 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
| 116 | 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) ) |
---|
| 117 | END DO |
---|
[3] | 118 | END DO |
---|
| 119 | END DO |
---|
| 120 | END DO |
---|
[503] | 121 | ! |
---|
[5836] | 122 | CASE ( 1 ) !* no damping in the turbocline (avt > 5 cm2/s) *! |
---|
[3] | 123 | DO jk = 1, jpkm1 |
---|
| 124 | DO jj = 2, jpjm1 |
---|
| 125 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[2528] | 126 | IF( avt(ji,jj,jk) <= 5.e-4_wp ) THEN |
---|
[5836] | 127 | tsa(ji,jj,jk,jp_tem) = tsa(ji,jj,jk,jp_tem) & |
---|
| 128 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_tem) - tsb(ji,jj,jk,jp_tem) ) |
---|
| 129 | tsa(ji,jj,jk,jp_sal) = tsa(ji,jj,jk,jp_sal) & |
---|
| 130 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_sal) - tsb(ji,jj,jk,jp_sal) ) |
---|
[3] | 131 | ENDIF |
---|
| 132 | END DO |
---|
| 133 | END DO |
---|
| 134 | END DO |
---|
[503] | 135 | ! |
---|
[5836] | 136 | CASE ( 2 ) !* no damping in the mixed layer *! |
---|
[3] | 137 | DO jk = 1, jpkm1 |
---|
| 138 | DO jj = 2, jpjm1 |
---|
| 139 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[6140] | 140 | IF( gdept_n(ji,jj,jk) >= hmlp (ji,jj) ) THEN |
---|
[5836] | 141 | tsa(ji,jj,jk,jp_tem) = tsa(ji,jj,jk,jp_tem) & |
---|
| 142 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_tem) - tsb(ji,jj,jk,jp_tem) ) |
---|
| 143 | tsa(ji,jj,jk,jp_sal) = tsa(ji,jj,jk,jp_sal) & |
---|
| 144 | & + resto(ji,jj,jk) * ( zts_dta(ji,jj,jk,jp_sal) - tsb(ji,jj,jk,jp_sal) ) |
---|
[3] | 145 | ENDIF |
---|
| 146 | END DO |
---|
| 147 | END DO |
---|
| 148 | END DO |
---|
[503] | 149 | ! |
---|
[3] | 150 | END SELECT |
---|
[2528] | 151 | ! |
---|
[1601] | 152 | IF( l_trdtra ) THEN ! trend diagnostic |
---|
[7753] | 153 | ztrdts(:,:,:,:) = tsa(:,:,:,:) - ztrdts(:,:,:,:) |
---|
[5836] | 154 | CALL trd_tra( kt, 'TRA', jp_tem, jptra_dmp, ztrdts(:,:,:,jp_tem) ) |
---|
| 155 | CALL trd_tra( kt, 'TRA', jp_sal, jptra_dmp, ztrdts(:,:,:,jp_sal) ) |
---|
| 156 | CALL wrk_dealloc( jpi,jpj,jpk,jpts, ztrdts ) |
---|
[216] | 157 | ENDIF |
---|
[1601] | 158 | ! ! Control print |
---|
[2528] | 159 | IF(ln_ctl) CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' dmp - Ta: ', mask1=tmask, & |
---|
| 160 | & tab3d_2=tsa(:,:,:,jp_sal), clinfo2= ' Sa: ', mask2=tmask, clinfo3='tra' ) |
---|
[503] | 161 | ! |
---|
[5836] | 162 | CALL wrk_dealloc( jpi,jpj,jpk,jpts, zts_dta ) |
---|
[3294] | 163 | ! |
---|
[5836] | 164 | IF( nn_timing == 1 ) CALL timing_stop('tra_dmp') |
---|
[3294] | 165 | ! |
---|
[3] | 166 | END SUBROUTINE tra_dmp |
---|
| 167 | |
---|
| 168 | |
---|
| 169 | SUBROUTINE tra_dmp_init |
---|
| 170 | !!---------------------------------------------------------------------- |
---|
| 171 | !! *** ROUTINE tra_dmp_init *** |
---|
| 172 | !! |
---|
| 173 | !! ** Purpose : Initialization for the newtonian damping |
---|
| 174 | !! |
---|
[4245] | 175 | !! ** Method : read the namtra_dmp namelist and check the parameters |
---|
[3] | 176 | !!---------------------------------------------------------------------- |
---|
[5836] | 177 | INTEGER :: ios, imask ! local integers |
---|
[6140] | 178 | ! |
---|
[5102] | 179 | NAMELIST/namtra_dmp/ ln_tradmp, nn_zdmp, cn_resto |
---|
[541] | 180 | !!---------------------------------------------------------------------- |
---|
[4990] | 181 | ! |
---|
[5102] | 182 | REWIND( numnam_ref ) ! Namelist namtra_dmp in reference namelist : T & S relaxation |
---|
[4147] | 183 | READ ( numnam_ref, namtra_dmp, IOSTAT = ios, ERR = 901) |
---|
| 184 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_dmp in reference namelist', lwp ) |
---|
[4990] | 185 | ! |
---|
[5102] | 186 | REWIND( numnam_cfg ) ! Namelist namtra_dmp in configuration namelist : T & S relaxation |
---|
[4147] | 187 | READ ( numnam_cfg, namtra_dmp, IOSTAT = ios, ERR = 902 ) |
---|
| 188 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_dmp in configuration namelist', lwp ) |
---|
[4624] | 189 | IF(lwm) WRITE ( numond, namtra_dmp ) |
---|
[5836] | 190 | ! |
---|
| 191 | IF(lwp) THEN ! Namelist print |
---|
[3] | 192 | WRITE(numout,*) |
---|
[5102] | 193 | WRITE(numout,*) 'tra_dmp_init : T and S newtonian relaxation' |
---|
[7646] | 194 | WRITE(numout,*) '~~~~~~~~~~~~' |
---|
[5102] | 195 | WRITE(numout,*) ' Namelist namtra_dmp : set relaxation parameters' |
---|
| 196 | WRITE(numout,*) ' Apply relaxation or not ln_tradmp = ', ln_tradmp |
---|
| 197 | WRITE(numout,*) ' mixed layer damping option nn_zdmp = ', nn_zdmp |
---|
| 198 | WRITE(numout,*) ' Damping file name cn_resto = ', cn_resto |
---|
[3294] | 199 | WRITE(numout,*) |
---|
[3] | 200 | ENDIF |
---|
[5836] | 201 | ! |
---|
[5102] | 202 | IF( ln_tradmp) THEN |
---|
[5836] | 203 | ! ! Allocate arrays |
---|
| 204 | IF( tra_dmp_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'tra_dmp_init: unable to allocate arrays' ) |
---|
[3294] | 205 | ! |
---|
[5836] | 206 | SELECT CASE (nn_zdmp) ! Check values of nn_zdmp |
---|
| 207 | CASE ( 0 ) ; IF(lwp) WRITE(numout,*) ' tracer damping as specified by mask' |
---|
| 208 | CASE ( 1 ) ; IF(lwp) WRITE(numout,*) ' no tracer damping in the mixing layer (kz > 5 cm2/s)' |
---|
| 209 | CASE ( 2 ) ; IF(lwp) WRITE(numout,*) ' no tracer damping in the mixed layer' |
---|
| 210 | CASE DEFAULT |
---|
| 211 | CALL ctl_stop('tra_dmp_init : wrong value of nn_zdmp') |
---|
[3294] | 212 | END SELECT |
---|
[5836] | 213 | ! |
---|
| 214 | !!TG: Initialisation of dtatsd - Would it be better to have dmpdta routine |
---|
| 215 | ! so can damp to something other than intitial conditions files? |
---|
| 216 | !!gm: In principle yes. Nevertheless, we can't anticipate demands that have never been formulated. |
---|
[3294] | 217 | IF( .NOT.ln_tsd_tradmp ) THEN |
---|
[5836] | 218 | IF(lwp) WRITE(numout,*) |
---|
| 219 | IF(lwp) WRITE(numout, *) ' read T-S data not initialized, we force ln_tsd_tradmp=T' |
---|
[3294] | 220 | CALL dta_tsd_init( ld_tradmp=ln_tradmp ) ! forces the initialisation of T-S data |
---|
| 221 | ENDIF |
---|
[5836] | 222 | ! ! Read in mask from file |
---|
[5102] | 223 | CALL iom_open ( cn_resto, imask) |
---|
[5836] | 224 | CALL iom_get ( imask, jpdom_autoglo, 'resto', resto ) |
---|
[5102] | 225 | CALL iom_close( imask ) |
---|
[5836] | 226 | ENDIF |
---|
| 227 | ! |
---|
[5102] | 228 | END SUBROUTINE tra_dmp_init |
---|
[3] | 229 | |
---|
[6140] | 230 | !!====================================================================== |
---|
[3] | 231 | END MODULE tradmp |
---|