[3132] | 1 | MODULE dtatsd |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE dtatsd *** |
---|
| 4 | !! Ocean data : read ocean Temperature & Salinity Data from gridded data |
---|
| 5 | !!====================================================================== |
---|
| 6 | !! History : OPA ! 1991-03 () Original code |
---|
| 7 | !! - ! 1992-07 (M. Imbard) |
---|
[14072] | 8 | !! 8.0 ! 1999-10 (M.A. Foujols, M. Imbard) NetCDF FORMAT |
---|
| 9 | !! NEMO 1.0 ! 2002-06 (G. Madec) F90: Free form and module |
---|
[3132] | 10 | !! 3.3 ! 2010-10 (C. Bricaud, S. Masson) use of fldread |
---|
[9490] | 11 | !! 3.4 ! 2010-11 (G. Madec, C. Ethe) Merge of dtatem and dtasal + remove CPP keys |
---|
[3132] | 12 | !!---------------------------------------------------------------------- |
---|
| 13 | |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
| 15 | !! dta_tsd : read and time interpolated ocean Temperature & Salinity Data |
---|
| 16 | !!---------------------------------------------------------------------- |
---|
| 17 | USE oce ! ocean dynamics and tracers |
---|
[9019] | 18 | USE phycst ! physical constants |
---|
[3132] | 19 | USE dom_oce ! ocean space and time domain |
---|
[14090] | 20 | USE domtile |
---|
[3132] | 21 | USE fldread ! read input fields |
---|
[9019] | 22 | ! |
---|
[3132] | 23 | USE in_out_manager ! I/O manager |
---|
| 24 | USE lib_mpp ! MPP library |
---|
| 25 | |
---|
| 26 | IMPLICIT NONE |
---|
| 27 | PRIVATE |
---|
| 28 | |
---|
| 29 | PUBLIC dta_tsd_init ! called by opa.F90 |
---|
| 30 | PUBLIC dta_tsd ! called by istate.F90 and tradmp.90 |
---|
| 31 | |
---|
[9490] | 32 | ! !!* namtsd namelist : Temperature & Salinity Data * |
---|
| 33 | LOGICAL , PUBLIC :: ln_tsd_init !: T & S data flag |
---|
| 34 | LOGICAL , PUBLIC :: ln_tsd_dmp !: internal damping toward input data flag |
---|
[3132] | 35 | |
---|
| 36 | TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_tsd ! structure of input SST (file informations, fields read) |
---|
| 37 | |
---|
[12377] | 38 | !! * Substitutions |
---|
| 39 | # include "do_loop_substitute.h90" |
---|
[3132] | 40 | !!---------------------------------------------------------------------- |
---|
[9598] | 41 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[14072] | 42 | !! $Id$ |
---|
[10068] | 43 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3132] | 44 | !!---------------------------------------------------------------------- |
---|
| 45 | CONTAINS |
---|
| 46 | |
---|
| 47 | SUBROUTINE dta_tsd_init( ld_tradmp ) |
---|
| 48 | !!---------------------------------------------------------------------- |
---|
| 49 | !! *** ROUTINE dta_tsd_init *** |
---|
[14072] | 50 | !! |
---|
| 51 | !! ** Purpose : initialisation of T & S input data |
---|
| 52 | !! |
---|
[3132] | 53 | !! ** Method : - Read namtsd namelist |
---|
[14072] | 54 | !! - allocates T & S data structure |
---|
[3132] | 55 | !!---------------------------------------------------------------------- |
---|
| 56 | LOGICAL, INTENT(in), OPTIONAL :: ld_tradmp ! force the initialization when tradp is used |
---|
| 57 | ! |
---|
[7646] | 58 | INTEGER :: ios, ierr0, ierr1, ierr2, ierr3 ! local integers |
---|
| 59 | !! |
---|
[3132] | 60 | CHARACTER(len=100) :: cn_dir ! Root directory for location of ssr files |
---|
| 61 | TYPE(FLD_N), DIMENSION( jpts) :: slf_i ! array of namelist informations on the fields to read |
---|
| 62 | TYPE(FLD_N) :: sn_tem, sn_sal |
---|
| 63 | !! |
---|
[9490] | 64 | NAMELIST/namtsd/ ln_tsd_init, ln_tsd_dmp, cn_dir, sn_tem, sn_sal |
---|
[3132] | 65 | !!---------------------------------------------------------------------- |
---|
[3162] | 66 | ! |
---|
[3266] | 67 | ! Initialisation |
---|
| 68 | ierr0 = 0 ; ierr1 = 0 ; ierr2 = 0 ; ierr3 = 0 |
---|
| 69 | ! |
---|
[4147] | 70 | READ ( numnam_ref, namtsd, IOSTAT = ios, ERR = 901) |
---|
[11536] | 71 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtsd in reference namelist' ) |
---|
[4147] | 72 | READ ( numnam_cfg, namtsd, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 73 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtsd in configuration namelist' ) |
---|
[4624] | 74 | IF(lwm) WRITE ( numond, namtsd ) |
---|
[3132] | 75 | |
---|
[9490] | 76 | IF( PRESENT( ld_tradmp ) ) ln_tsd_dmp = .TRUE. ! forces the initialization when tradmp is used |
---|
[14072] | 77 | |
---|
[3132] | 78 | IF(lwp) THEN ! control print |
---|
| 79 | WRITE(numout,*) |
---|
| 80 | WRITE(numout,*) 'dta_tsd_init : Temperature & Salinity data ' |
---|
| 81 | WRITE(numout,*) '~~~~~~~~~~~~ ' |
---|
| 82 | WRITE(numout,*) ' Namelist namtsd' |
---|
[9490] | 83 | WRITE(numout,*) ' Initialisation of ocean T & S with T &S input data ln_tsd_init = ', ln_tsd_init |
---|
| 84 | WRITE(numout,*) ' damping of ocean T & S toward T &S input data ln_tsd_dmp = ', ln_tsd_dmp |
---|
[3132] | 85 | WRITE(numout,*) |
---|
[9490] | 86 | IF( .NOT.ln_tsd_init .AND. .NOT.ln_tsd_dmp ) THEN |
---|
[3132] | 87 | WRITE(numout,*) |
---|
[9490] | 88 | WRITE(numout,*) ' ===>> T & S data not used' |
---|
[3132] | 89 | ENDIF |
---|
| 90 | ENDIF |
---|
| 91 | ! |
---|
| 92 | IF( ln_rstart .AND. ln_tsd_init ) THEN |
---|
| 93 | CALL ctl_warn( 'dta_tsd_init: ocean restart and T & S data intialisation, ', & |
---|
| 94 | & 'we keep the restart T & S values and set ln_tsd_init to FALSE' ) |
---|
| 95 | ln_tsd_init = .FALSE. |
---|
| 96 | ENDIF |
---|
| 97 | ! |
---|
| 98 | ! ! allocate the arrays (if necessary) |
---|
[9490] | 99 | IF( ln_tsd_init .OR. ln_tsd_dmp ) THEN |
---|
[3132] | 100 | ! |
---|
| 101 | ALLOCATE( sf_tsd(jpts), STAT=ierr0 ) |
---|
| 102 | IF( ierr0 > 0 ) THEN |
---|
| 103 | CALL ctl_stop( 'dta_tsd_init: unable to allocate sf_tsd structure' ) ; RETURN |
---|
| 104 | ENDIF |
---|
| 105 | ! |
---|
| 106 | ALLOCATE( sf_tsd(jp_tem)%fnow(jpi,jpj,jpk) , STAT=ierr0 ) |
---|
| 107 | IF( sn_tem%ln_tint ) ALLOCATE( sf_tsd(jp_tem)%fdta(jpi,jpj,jpk,2) , STAT=ierr1 ) |
---|
| 108 | ALLOCATE( sf_tsd(jp_sal)%fnow(jpi,jpj,jpk) , STAT=ierr2 ) |
---|
| 109 | IF( sn_sal%ln_tint ) ALLOCATE( sf_tsd(jp_sal)%fdta(jpi,jpj,jpk,2) , STAT=ierr3 ) |
---|
| 110 | ! |
---|
| 111 | IF( ierr0 + ierr1 + ierr2 + ierr3 > 0 ) THEN |
---|
| 112 | CALL ctl_stop( 'dta_tsd : unable to allocate T & S data arrays' ) ; RETURN |
---|
| 113 | ENDIF |
---|
| 114 | ! ! fill sf_tsd with sn_tem & sn_sal and control print |
---|
| 115 | slf_i(jp_tem) = sn_tem ; slf_i(jp_sal) = sn_sal |
---|
[7646] | 116 | CALL fld_fill( sf_tsd, slf_i, cn_dir, 'dta_tsd', 'Temperature & Salinity data', 'namtsd', no_print ) |
---|
[3132] | 117 | ! |
---|
| 118 | ENDIF |
---|
| 119 | ! |
---|
| 120 | END SUBROUTINE dta_tsd_init |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | SUBROUTINE dta_tsd( kt, ptsd ) |
---|
| 124 | !!---------------------------------------------------------------------- |
---|
| 125 | !! *** ROUTINE dta_tsd *** |
---|
[14072] | 126 | !! |
---|
[3132] | 127 | !! ** Purpose : provides T and S data at kt |
---|
[14072] | 128 | !! |
---|
[3132] | 129 | !! ** Method : - call fldread routine |
---|
[14072] | 130 | !! - ORCA_R2: add some hand made alteration to read data |
---|
[3132] | 131 | !! - 'key_orca_lev10' interpolates on 10 times more levels |
---|
| 132 | !! - s- or mixed z-s coordinate: vertical interpolation on model mesh |
---|
[9490] | 133 | !! - ln_tsd_dmp=F: deallocates the T-S data structure |
---|
[3132] | 134 | !! as T-S data are no are used |
---|
| 135 | !! |
---|
| 136 | !! ** Action : ptsd T-S data on medl mesh and interpolated at time-step kt |
---|
| 137 | !!---------------------------------------------------------------------- |
---|
[13982] | 138 | INTEGER , INTENT(in ) :: kt ! ocean time-step |
---|
| 139 | REAL(wp), DIMENSION(A2D(nn_hls),jpk,jpts), INTENT( out) :: ptsd ! T & S data |
---|
[3132] | 140 | ! |
---|
| 141 | INTEGER :: ji, jj, jk, jl, jkk ! dummy loop indicies |
---|
| 142 | INTEGER :: ik, il0, il1, ii0, ii1, ij0, ij1 ! local integers |
---|
[14186] | 143 | INTEGER, DIMENSION(jpts), SAVE :: irec_b, irec_n |
---|
[9019] | 144 | REAL(wp):: zl, zi ! local scalars |
---|
| 145 | REAL(wp), DIMENSION(jpk) :: ztp, zsp ! 1D workspace |
---|
[3132] | 146 | !!---------------------------------------------------------------------- |
---|
| 147 | ! |
---|
[14834] | 148 | IF( .NOT. l_istiled .OR. ntile == 1 ) THEN ! Do only for the full domain |
---|
| 149 | IF( ln_tile ) CALL dom_tile_stop( ldhold=.TRUE. ) ! Use full domain |
---|
[13982] | 150 | CALL fld_read( kt, 1, sf_tsd ) !== read T & S data at kt time step ==! |
---|
[3132] | 151 | ! |
---|
| 152 | ! |
---|
[7646] | 153 | !!gm This should be removed from the code ===>>>> T & S files has to be changed |
---|
[13982] | 154 | ! |
---|
| 155 | ! !== ORCA_R2 configuration and T & S damping ==! |
---|
| 156 | IF( cn_cfg == "orca" .OR. cn_cfg == "ORCA" ) THEN |
---|
| 157 | IF( nn_cfg == 2 .AND. ln_tsd_dmp ) THEN ! some hand made alterations |
---|
[14186] | 158 | irec_n(jp_tem) = sf_tsd(jp_tem)%nrec(2,sf_tsd(jp_tem)%naa) ! Determine if there is new data (ln_tint = F) |
---|
| 159 | irec_n(jp_sal) = sf_tsd(jp_sal)%nrec(2,sf_tsd(jp_sal)%naa) ! If not, then do not apply the increments |
---|
| 160 | IF( kt == nit000 ) irec_b(:) = -1 |
---|
[13982] | 161 | ! |
---|
| 162 | ij0 = 101 + nn_hls ; ij1 = 109 + nn_hls ! Reduced T & S in the Alboran Sea |
---|
| 163 | ii0 = 141 + nn_hls - 1 ; ii1 = 155 + nn_hls - 1 |
---|
[14186] | 164 | IF( sf_tsd(jp_tem)%ln_tint .OR. irec_n(jp_tem) /= irec_b(jp_tem) ) THEN |
---|
| 165 | DO jj = mj0(ij0), mj1(ij1) |
---|
| 166 | DO ji = mi0(ii0), mi1(ii1) |
---|
| 167 | sf_tsd(jp_tem)%fnow(ji,jj,13:13) = sf_tsd(jp_tem)%fnow(ji,jj,13:13) - 0.20_wp |
---|
| 168 | sf_tsd(jp_tem)%fnow(ji,jj,14:15) = sf_tsd(jp_tem)%fnow(ji,jj,14:15) - 0.35_wp |
---|
| 169 | sf_tsd(jp_tem)%fnow(ji,jj,16:25) = sf_tsd(jp_tem)%fnow(ji,jj,16:25) - 0.40_wp |
---|
| 170 | END DO |
---|
[13982] | 171 | END DO |
---|
[14186] | 172 | irec_b(jp_tem) = irec_n(jp_tem) |
---|
| 173 | ENDIF |
---|
| 174 | ! |
---|
| 175 | IF( sf_tsd(jp_sal)%ln_tint .OR. irec_n(jp_sal) /= irec_b(jp_sal) ) THEN |
---|
| 176 | DO jj = mj0(ij0), mj1(ij1) |
---|
| 177 | DO ji = mi0(ii0), mi1(ii1) |
---|
| 178 | sf_tsd(jp_sal)%fnow(ji,jj,13:13) = sf_tsd(jp_sal)%fnow(ji,jj,13:13) - 0.15_wp |
---|
| 179 | sf_tsd(jp_sal)%fnow(ji,jj,14:15) = sf_tsd(jp_sal)%fnow(ji,jj,14:15) - 0.25_wp |
---|
| 180 | sf_tsd(jp_sal)%fnow(ji,jj,16:17) = sf_tsd(jp_sal)%fnow(ji,jj,16:17) - 0.30_wp |
---|
| 181 | sf_tsd(jp_sal)%fnow(ji,jj,18:25) = sf_tsd(jp_sal)%fnow(ji,jj,18:25) - 0.35_wp |
---|
| 182 | END DO |
---|
| 183 | END DO |
---|
| 184 | irec_b(jp_sal) = irec_n(jp_sal) |
---|
| 185 | ENDIF |
---|
| 186 | ! |
---|
[13982] | 187 | ij0 = 87 + nn_hls ; ij1 = 96 + nn_hls ! Reduced temperature in Red Sea |
---|
| 188 | ii0 = 148 + nn_hls - 1 ; ii1 = 160 + nn_hls - 1 |
---|
| 189 | sf_tsd(jp_tem)%fnow( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) , 4:10 ) = 7.0_wp |
---|
| 190 | sf_tsd(jp_tem)%fnow( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) , 11:13 ) = 6.5_wp |
---|
| 191 | sf_tsd(jp_tem)%fnow( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) , 14:20 ) = 6.0_wp |
---|
| 192 | ENDIF |
---|
[10213] | 193 | ENDIF |
---|
[13982] | 194 | !!gm end |
---|
[14834] | 195 | IF( ln_tile ) CALL dom_tile_start( ldhold=.TRUE. ) ! Revert to tile domain |
---|
[3132] | 196 | ENDIF |
---|
| 197 | ! |
---|
[13982] | 198 | DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpk ) |
---|
| 199 | ptsd(ji,jj,jk,jp_tem) = sf_tsd(jp_tem)%fnow(ji,jj,jk) ! NO mask |
---|
| 200 | ptsd(ji,jj,jk,jp_sal) = sf_tsd(jp_sal)%fnow(ji,jj,jk) |
---|
| 201 | END_3D |
---|
[3132] | 202 | ! |
---|
| 203 | IF( ln_sco ) THEN !== s- or mixed s-zps-coordinate ==! |
---|
| 204 | ! |
---|
[14834] | 205 | IF( .NOT. l_istiled .OR. ntile == 1 ) THEN ! Do only on the first tile |
---|
[13982] | 206 | IF( kt == nit000 .AND. lwp )THEN |
---|
| 207 | WRITE(numout,*) |
---|
| 208 | WRITE(numout,*) 'dta_tsd: interpolates T & S data onto the s- or mixed s-z-coordinate mesh' |
---|
| 209 | ENDIF |
---|
[3132] | 210 | ENDIF |
---|
| 211 | ! |
---|
[13982] | 212 | DO_2D( nn_hls, nn_hls, nn_hls, nn_hls ) ! vertical interpolation of T & S |
---|
[12377] | 213 | DO jk = 1, jpk ! determines the intepolated T-S profiles at each (i,j) points |
---|
| 214 | zl = gdept_0(ji,jj,jk) |
---|
| 215 | IF( zl < gdept_1d(1 ) ) THEN ! above the first level of data |
---|
| 216 | ztp(jk) = ptsd(ji,jj,1 ,jp_tem) |
---|
| 217 | zsp(jk) = ptsd(ji,jj,1 ,jp_sal) |
---|
| 218 | ELSEIF( zl > gdept_1d(jpk) ) THEN ! below the last level of data |
---|
| 219 | ztp(jk) = ptsd(ji,jj,jpkm1,jp_tem) |
---|
| 220 | zsp(jk) = ptsd(ji,jj,jpkm1,jp_sal) |
---|
| 221 | ELSE ! inbetween : vertical interpolation between jkk & jkk+1 |
---|
| 222 | DO jkk = 1, jpkm1 ! when gdept(jkk) < zl < gdept(jkk+1) |
---|
| 223 | IF( (zl-gdept_1d(jkk)) * (zl-gdept_1d(jkk+1)) <= 0._wp ) THEN |
---|
| 224 | zi = ( zl - gdept_1d(jkk) ) / (gdept_1d(jkk+1)-gdept_1d(jkk)) |
---|
[14072] | 225 | ztp(jk) = ptsd(ji,jj,jkk,jp_tem) + ( ptsd(ji,jj,jkk+1,jp_tem) - ptsd(ji,jj,jkk,jp_tem) ) * zi |
---|
[12377] | 226 | zsp(jk) = ptsd(ji,jj,jkk,jp_sal) + ( ptsd(ji,jj,jkk+1,jp_sal) - ptsd(ji,jj,jkk,jp_sal) ) * zi |
---|
| 227 | ENDIF |
---|
| 228 | END DO |
---|
| 229 | ENDIF |
---|
[3132] | 230 | END DO |
---|
[12377] | 231 | DO jk = 1, jpkm1 |
---|
| 232 | ptsd(ji,jj,jk,jp_tem) = ztp(jk) * tmask(ji,jj,jk) ! mask required for mixed zps-s-coord |
---|
| 233 | ptsd(ji,jj,jk,jp_sal) = zsp(jk) * tmask(ji,jj,jk) |
---|
| 234 | END DO |
---|
| 235 | ptsd(ji,jj,jpk,jp_tem) = 0._wp |
---|
| 236 | ptsd(ji,jj,jpk,jp_sal) = 0._wp |
---|
| 237 | END_2D |
---|
[14072] | 238 | ! |
---|
[3132] | 239 | ELSE !== z- or zps- coordinate ==! |
---|
[14072] | 240 | ! |
---|
[13982] | 241 | DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpk ) |
---|
| 242 | ptsd(ji,jj,jk,jp_tem) = ptsd(ji,jj,jk,jp_tem) * tmask(ji,jj,jk) ! Mask |
---|
| 243 | ptsd(ji,jj,jk,jp_sal) = ptsd(ji,jj,jk,jp_sal) * tmask(ji,jj,jk) |
---|
| 244 | END_3D |
---|
[3132] | 245 | ! |
---|
| 246 | IF( ln_zps ) THEN ! zps-coordinate (partial steps) interpolation at the last ocean level |
---|
[13982] | 247 | DO_2D( nn_hls, nn_hls, nn_hls, nn_hls ) |
---|
[14072] | 248 | ik = mbkt(ji,jj) |
---|
[12377] | 249 | IF( ik > 1 ) THEN |
---|
| 250 | zl = ( gdept_1d(ik) - gdept_0(ji,jj,ik) ) / ( gdept_1d(ik) - gdept_1d(ik-1) ) |
---|
| 251 | ptsd(ji,jj,ik,jp_tem) = (1.-zl) * ptsd(ji,jj,ik,jp_tem) + zl * ptsd(ji,jj,ik-1,jp_tem) |
---|
| 252 | ptsd(ji,jj,ik,jp_sal) = (1.-zl) * ptsd(ji,jj,ik,jp_sal) + zl * ptsd(ji,jj,ik-1,jp_sal) |
---|
| 253 | ENDIF |
---|
| 254 | ik = mikt(ji,jj) |
---|
| 255 | IF( ik > 1 ) THEN |
---|
[14072] | 256 | zl = ( gdept_0(ji,jj,ik) - gdept_1d(ik) ) / ( gdept_1d(ik+1) - gdept_1d(ik) ) |
---|
[12377] | 257 | ptsd(ji,jj,ik,jp_tem) = (1.-zl) * ptsd(ji,jj,ik,jp_tem) + zl * ptsd(ji,jj,ik+1,jp_tem) |
---|
| 258 | ptsd(ji,jj,ik,jp_sal) = (1.-zl) * ptsd(ji,jj,ik,jp_sal) + zl * ptsd(ji,jj,ik+1,jp_sal) |
---|
| 259 | END IF |
---|
| 260 | END_2D |
---|
[3132] | 261 | ENDIF |
---|
| 262 | ! |
---|
| 263 | ENDIF |
---|
| 264 | ! |
---|
[14072] | 265 | IF( .NOT.ln_tsd_dmp ) THEN !== deallocate T & S structure ==! |
---|
[3132] | 266 | ! (data used only for initialisation) |
---|
| 267 | IF(lwp) WRITE(numout,*) 'dta_tsd: deallocte T & S arrays as they are only use to initialize the run' |
---|
| 268 | DEALLOCATE( sf_tsd(jp_tem)%fnow ) ! T arrays in the structure |
---|
| 269 | IF( sf_tsd(jp_tem)%ln_tint ) DEALLOCATE( sf_tsd(jp_tem)%fdta ) |
---|
| 270 | DEALLOCATE( sf_tsd(jp_sal)%fnow ) ! S arrays in the structure |
---|
| 271 | IF( sf_tsd(jp_sal)%ln_tint ) DEALLOCATE( sf_tsd(jp_sal)%fdta ) |
---|
| 272 | DEALLOCATE( sf_tsd ) ! the structure itself |
---|
| 273 | ENDIF |
---|
| 274 | ! |
---|
| 275 | END SUBROUTINE dta_tsd |
---|
| 276 | |
---|
| 277 | !!====================================================================== |
---|
| 278 | END MODULE dtatsd |
---|