[268] | 1 | MODULE trcdta |
---|
| 2 | !!====================================================================== |
---|
[433] | 3 | !! *** MODULE trcdta *** |
---|
[945] | 4 | !! TOP : reads passive tracer data |
---|
[268] | 5 | !!===================================================================== |
---|
[945] | 6 | !! History : 1.0 ! 2002-04 (O. Aumont) original code |
---|
| 7 | !! - ! 2004-03 (C. Ethe) module |
---|
| 8 | !! - ! 2005-03 (O. Aumont, A. El Moussaoui) F90 |
---|
[3294] | 9 | !! 3.4 ! 2010-11 (C. Ethe, G. Madec) use of fldread + dynamical allocation |
---|
[4230] | 10 | !! 3.5 ! 2013-08 (M. Vichi) generalization for other BGC models |
---|
[274] | 11 | !!---------------------------------------------------------------------- |
---|
[3294] | 12 | #if defined key_top |
---|
[268] | 13 | !!---------------------------------------------------------------------- |
---|
[3294] | 14 | !! 'key_top' TOP model |
---|
[268] | 15 | !!---------------------------------------------------------------------- |
---|
[3294] | 16 | !! trc_dta : read and time interpolated passive tracer data |
---|
[268] | 17 | !!---------------------------------------------------------------------- |
---|
[3294] | 18 | USE par_trc ! passive tracers parameters |
---|
| 19 | USE oce_trc ! shared variables between ocean and passive tracers |
---|
| 20 | USE trc ! passive tracers common variables |
---|
| 21 | USE iom ! I/O manager |
---|
| 22 | USE lib_mpp ! MPP library |
---|
| 23 | USE fldread ! read input fields |
---|
[268] | 24 | |
---|
[11738] | 25 | USE yomhook, ONLY: lhook, dr_hook |
---|
| 26 | USE parkind1, ONLY: jprb, jpim |
---|
| 27 | |
---|
[268] | 28 | IMPLICIT NONE |
---|
| 29 | PRIVATE |
---|
| 30 | |
---|
[2715] | 31 | PUBLIC trc_dta ! called in trcini.F90 and trcdmp.F90 |
---|
[3294] | 32 | PUBLIC trc_dta_init ! called in trcini.F90 |
---|
[268] | 33 | |
---|
[3294] | 34 | INTEGER , SAVE, PUBLIC :: nb_trcdta ! number of tracers to be initialised with data |
---|
| 35 | INTEGER , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: n_trc_index ! indice of tracer which is initialised with data |
---|
[4230] | 36 | INTEGER , SAVE, PUBLIC :: ntra ! MAX( 1, nb_trcdta ) to avoid compilation error with bounds checking |
---|
| 37 | REAL(wp) , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: rf_trfac ! multiplicative factor for tracer values |
---|
[4489] | 38 | !$AGRIF_DO_NOT_TREAT |
---|
[4230] | 39 | TYPE(FLD), SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: sf_trcdta ! structure of input SST (file informations, fields read) |
---|
[4489] | 40 | !$AGRIF_END_DO_NOT_TREAT |
---|
[268] | 41 | !! * Substitutions |
---|
[3294] | 42 | # include "domzgr_substitute.h90" |
---|
[268] | 43 | !!---------------------------------------------------------------------- |
---|
[3294] | 44 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[6486] | 45 | !! $Id$ |
---|
[2715] | 46 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[268] | 47 | !!---------------------------------------------------------------------- |
---|
| 48 | CONTAINS |
---|
| 49 | |
---|
[4230] | 50 | SUBROUTINE trc_dta_init(ntrc) |
---|
[335] | 51 | !!---------------------------------------------------------------------- |
---|
[3294] | 52 | !! *** ROUTINE trc_dta_init *** |
---|
| 53 | !! |
---|
| 54 | !! ** Purpose : initialisation of passive tracer input data |
---|
| 55 | !! |
---|
| 56 | !! ** Method : - Read namtsd namelist |
---|
| 57 | !! - allocates passive tracer data structure |
---|
[335] | 58 | !!---------------------------------------------------------------------- |
---|
[3294] | 59 | ! |
---|
[4230] | 60 | INTEGER,INTENT(IN) :: ntrc ! number of tracers |
---|
| 61 | INTEGER :: jl, jn ! dummy loop indices |
---|
[3294] | 62 | INTEGER :: ierr0, ierr1, ierr2, ierr3 ! temporary integers |
---|
[4147] | 63 | INTEGER :: ios ! Local integer output status for namelist read |
---|
[3294] | 64 | CHARACTER(len=100) :: clndta, clntrc |
---|
| 65 | REAL(wp) :: zfact |
---|
| 66 | ! |
---|
[4147] | 67 | CHARACTER(len=100) :: cn_dir |
---|
[4230] | 68 | TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) :: slf_i ! array of namelist informations on the fields to read |
---|
| 69 | TYPE(FLD_N), DIMENSION(jpmaxtrc) :: sn_trcdta |
---|
| 70 | REAL(wp) , DIMENSION(jpmaxtrc) :: rn_trfac ! multiplicative factor for tracer values |
---|
[945] | 71 | !! |
---|
[3294] | 72 | NAMELIST/namtrc_dta/ sn_trcdta, cn_dir, rn_trfac |
---|
[11738] | 73 | INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0 |
---|
| 74 | INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1 |
---|
| 75 | REAL(KIND=jprb) :: zhook_handle |
---|
| 76 | |
---|
| 77 | CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_DTA_INIT' |
---|
| 78 | |
---|
| 79 | IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle) |
---|
| 80 | |
---|
[335] | 81 | !!---------------------------------------------------------------------- |
---|
[3294] | 82 | ! |
---|
| 83 | IF( nn_timing == 1 ) CALL timing_start('trc_dta_init') |
---|
| 84 | ! |
---|
| 85 | ! Initialisation |
---|
| 86 | ierr0 = 0 ; ierr1 = 0 ; ierr2 = 0 ; ierr3 = 0 |
---|
| 87 | ! Compute the number of tracers to be initialised with data |
---|
[4230] | 88 | ALLOCATE( n_trc_index(ntrc), slf_i(ntrc), STAT=ierr0 ) |
---|
[3294] | 89 | IF( ierr0 > 0 ) THEN |
---|
[6793] | 90 | CALL ctl_stop( 'trc_dta_init: unable to allocate n_trc_index' ) ; RETURN |
---|
[3294] | 91 | ENDIF |
---|
| 92 | nb_trcdta = 0 |
---|
| 93 | n_trc_index(:) = 0 |
---|
[4230] | 94 | DO jn = 1, ntrc |
---|
[3294] | 95 | IF( ln_trc_ini(jn) ) THEN |
---|
| 96 | nb_trcdta = nb_trcdta + 1 |
---|
| 97 | n_trc_index(jn) = nb_trcdta |
---|
| 98 | ENDIF |
---|
| 99 | ENDDO |
---|
| 100 | ! |
---|
| 101 | ntra = MAX( 1, nb_trcdta ) ! To avoid compilation error with bounds checking |
---|
[3827] | 102 | IF(lwp) THEN |
---|
| 103 | WRITE(numout,*) ' ' |
---|
[6793] | 104 | WRITE(numout,*) 'trc_dta_init : Passive tracers Initial Conditions ' |
---|
| 105 | WRITE(numout,*) '~~~~~~~~~~~~~~ ' |
---|
[3827] | 106 | WRITE(numout,*) ' number of passive tracers to be initialize by data :', ntra |
---|
| 107 | WRITE(numout,*) ' ' |
---|
| 108 | ENDIF |
---|
[3294] | 109 | ! |
---|
[4147] | 110 | REWIND( numnat_ref ) ! Namelist namtrc_dta in reference namelist : Passive tracer input data |
---|
| 111 | READ ( numnat_ref, namtrc_dta, IOSTAT = ios, ERR = 901) |
---|
| 112 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dta in reference namelist', lwp ) |
---|
[268] | 113 | |
---|
[4147] | 114 | REWIND( numnat_cfg ) ! Namelist namtrc_dta in configuration namelist : Passive tracer input data |
---|
| 115 | READ ( numnat_cfg, namtrc_dta, IOSTAT = ios, ERR = 902 ) |
---|
| 116 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_dta in configuration namelist', lwp ) |
---|
[4624] | 117 | IF(lwm) WRITE ( numont, namtrc_dta ) |
---|
[4147] | 118 | |
---|
[3294] | 119 | IF( lwp ) THEN |
---|
[4230] | 120 | DO jn = 1, ntrc |
---|
[3294] | 121 | IF( ln_trc_ini(jn) ) THEN ! open input file only if ln_trc_ini(jn) is true |
---|
[6793] | 122 | clndta = TRIM( sn_trcdta(jn)%clvar ) |
---|
| 123 | if (jn > jptra) then |
---|
| 124 | clntrc='Dummy' ! By pass weird formats in ocean.output if ntrc > jptra |
---|
| 125 | else |
---|
| 126 | clntrc = TRIM( ctrcnm (jn) ) |
---|
| 127 | endif |
---|
[3294] | 128 | zfact = rn_trfac(jn) |
---|
[6793] | 129 | IF( clndta /= clntrc ) THEN |
---|
| 130 | CALL ctl_warn( 'trc_dta_init: passive tracer data initialisation ', & |
---|
| 131 | & 'Input name of data file : '//TRIM(clndta)// & |
---|
| 132 | & ' differs from that of tracer : '//TRIM(clntrc)//' ') |
---|
[3294] | 133 | ENDIF |
---|
[6793] | 134 | WRITE(numout,'(a, i4,3a,e11.3)') ' Read IC file for tracer number :', & |
---|
| 135 | & jn, ', name : ', TRIM(clndta), ', Multiplicative Scaling factor : ', zfact |
---|
[335] | 136 | ENDIF |
---|
[3294] | 137 | END DO |
---|
| 138 | ENDIF |
---|
| 139 | ! |
---|
| 140 | IF( nb_trcdta > 0 ) THEN ! allocate only if the number of tracer to initialise is greater than zero |
---|
| 141 | ALLOCATE( sf_trcdta(nb_trcdta), rf_trfac(nb_trcdta), STAT=ierr1 ) |
---|
| 142 | IF( ierr1 > 0 ) THEN |
---|
[6793] | 143 | CALL ctl_stop( 'trc_dta_init: unable to allocate sf_trcdta structure' ) ; RETURN |
---|
[3294] | 144 | ENDIF |
---|
| 145 | ! |
---|
[4230] | 146 | DO jn = 1, ntrc |
---|
[3294] | 147 | IF( ln_trc_ini(jn) ) THEN ! update passive tracers arrays with input data read from file |
---|
| 148 | jl = n_trc_index(jn) |
---|
| 149 | slf_i(jl) = sn_trcdta(jn) |
---|
| 150 | rf_trfac(jl) = rn_trfac(jn) |
---|
| 151 | ALLOCATE( sf_trcdta(jl)%fnow(jpi,jpj,jpk) , STAT=ierr2 ) |
---|
| 152 | IF( sn_trcdta(jn)%ln_tint ) ALLOCATE( sf_trcdta(jl)%fdta(jpi,jpj,jpk,2) , STAT=ierr3 ) |
---|
| 153 | IF( ierr2 + ierr3 > 0 ) THEN |
---|
[6793] | 154 | CALL ctl_stop( 'trc_dta_init : unable to allocate passive tracer data arrays' ) ; RETURN |
---|
[3294] | 155 | ENDIF |
---|
| 156 | ENDIF |
---|
| 157 | ! |
---|
| 158 | ENDDO |
---|
| 159 | ! ! fill sf_trcdta with slf_i and control print |
---|
[6793] | 160 | CALL fld_fill( sf_trcdta, slf_i, cn_dir, 'trc_dta_init', 'Passive tracer data', 'namtrc' ) |
---|
[3294] | 161 | ! |
---|
| 162 | ENDIF |
---|
| 163 | ! |
---|
[4230] | 164 | DEALLOCATE( slf_i ) ! deallocate local field structure |
---|
[3294] | 165 | IF( nn_timing == 1 ) CALL timing_stop('trc_dta_init') |
---|
| 166 | ! |
---|
[11738] | 167 | IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle) |
---|
[3294] | 168 | END SUBROUTINE trc_dta_init |
---|
[268] | 169 | |
---|
[493] | 170 | |
---|
[6793] | 171 | SUBROUTINE trc_dta( kt, sf_dta, ptrfac, ptrc) |
---|
[3294] | 172 | !!---------------------------------------------------------------------- |
---|
| 173 | !! *** ROUTINE trc_dta *** |
---|
| 174 | !! |
---|
| 175 | !! ** Purpose : provides passive tracer data at kt |
---|
| 176 | !! |
---|
| 177 | !! ** Method : - call fldread routine |
---|
| 178 | !! - s- or mixed z-s coordinate: vertical interpolation on model mesh |
---|
| 179 | !! - ln_trcdmp=F: deallocates the data structure as they are not used |
---|
| 180 | !! |
---|
[4230] | 181 | !! ** Action : sf_dta passive tracer data on medl mesh and interpolated at time-step kt |
---|
[3294] | 182 | !!---------------------------------------------------------------------- |
---|
| 183 | INTEGER , INTENT(in ) :: kt ! ocean time-step |
---|
[6793] | 184 | TYPE(FLD), DIMENSION(1) , INTENT(inout) :: sf_dta ! array of information on the field to read |
---|
| 185 | REAL(wp) , INTENT(in ) :: ptrfac ! multiplication factor |
---|
| 186 | REAL(wp), DIMENSION(jpi,jpj,jpk), OPTIONAL , INTENT(out ) :: ptrc |
---|
[3294] | 187 | ! |
---|
[4230] | 188 | INTEGER :: ji, jj, jk, jl, jkk, ik ! dummy loop indices |
---|
[3294] | 189 | REAL(wp):: zl, zi |
---|
| 190 | REAL(wp), DIMENSION(jpk) :: ztp ! 1D workspace |
---|
[6793] | 191 | REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrcdta ! 3D workspace |
---|
[3294] | 192 | CHARACTER(len=100) :: clndta |
---|
[11738] | 193 | INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0 |
---|
| 194 | INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1 |
---|
| 195 | REAL(KIND=jprb) :: zhook_handle |
---|
| 196 | |
---|
| 197 | CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_DTA' |
---|
| 198 | |
---|
| 199 | IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle) |
---|
| 200 | |
---|
[3294] | 201 | !!---------------------------------------------------------------------- |
---|
| 202 | ! |
---|
| 203 | IF( nn_timing == 1 ) CALL timing_start('trc_dta') |
---|
| 204 | ! |
---|
| 205 | IF( nb_trcdta > 0 ) THEN |
---|
| 206 | ! |
---|
[6793] | 207 | CALL wrk_alloc( jpi, jpj, jpk, ztrcdta ) ! Memory allocation |
---|
| 208 | ! |
---|
[4230] | 209 | CALL fld_read( kt, 1, sf_dta ) !== read data at kt time step ==! |
---|
[6793] | 210 | ztrcdta(:,:,:) = sf_dta(1)%fnow(:,:,:) * tmask(:,:,:) ! Mask |
---|
[3294] | 211 | ! |
---|
| 212 | IF( ln_sco ) THEN !== s- or mixed s-zps-coordinate ==! |
---|
| 213 | ! |
---|
| 214 | IF( kt == nit000 .AND. lwp )THEN |
---|
| 215 | WRITE(numout,*) |
---|
| 216 | WRITE(numout,*) 'trc_dta: interpolates passive tracer data onto the s- or mixed s-z-coordinate mesh' |
---|
[268] | 217 | ENDIF |
---|
[3294] | 218 | ! |
---|
[6793] | 219 | DO jj = 1, jpj ! vertical interpolation of T & S |
---|
| 220 | DO ji = 1, jpi |
---|
| 221 | DO jk = 1, jpk ! determines the intepolated T-S profiles at each (i,j) points |
---|
| 222 | zl = fsdept_n(ji,jj,jk) |
---|
| 223 | IF( zl < gdept_1d(1 ) ) THEN ! above the first level of data |
---|
| 224 | ztp(jk) = ztrcdta(ji,jj,1) |
---|
| 225 | ELSEIF( zl > gdept_1d(jpk) ) THEN ! below the last level of data |
---|
| 226 | ztp(jk) = ztrcdta(ji,jj,jpkm1) |
---|
| 227 | ELSE ! inbetween : vertical interpolation between jkk & jkk+1 |
---|
| 228 | DO jkk = 1, jpkm1 ! when gdept(jkk) < zl < gdept(jkk+1) |
---|
| 229 | IF( (zl-gdept_1d(jkk)) * (zl-gdept_1d(jkk+1)) <= 0._wp ) THEN |
---|
| 230 | zi = ( zl - gdept_1d(jkk) ) / (gdept_1d(jkk+1)-gdept_1d(jkk)) |
---|
| 231 | ztp(jk) = ztrcdta(ji,jj,jkk) + ( ztrcdta(ji,jj,jkk+1) - & |
---|
| 232 | ztrcdta(ji,jj,jkk) ) * zi |
---|
| 233 | ENDIF |
---|
| 234 | END DO |
---|
| 235 | ENDIF |
---|
[3294] | 236 | END DO |
---|
[6793] | 237 | DO jk = 1, jpkm1 |
---|
| 238 | ztrcdta(ji,jj,jk) = ztp(jk) * tmask(ji,jj,jk) ! mask required for mixed zps-s-coord |
---|
| 239 | END DO |
---|
| 240 | ztrcdta(ji,jj,jpk) = 0._wp |
---|
| 241 | END DO |
---|
| 242 | END DO |
---|
[3294] | 243 | ! |
---|
| 244 | ELSE !== z- or zps- coordinate ==! |
---|
[6793] | 245 | ! |
---|
| 246 | IF( ln_zps ) THEN ! zps-coordinate (partial steps) interpolation at the last ocean level |
---|
| 247 | DO jj = 1, jpj |
---|
| 248 | DO ji = 1, jpi |
---|
| 249 | ik = mbkt(ji,jj) |
---|
| 250 | IF( ik > 1 ) THEN |
---|
| 251 | zl = ( gdept_1d(ik) - fsdept_n(ji,jj,ik) ) / ( gdept_1d(ik) - gdept_1d(ik-1) ) |
---|
| 252 | ztrcdta(ji,jj,ik) = (1.-zl) * ztrcdta(ji,jj,ik) + zl * ztrcdta(ji,jj,ik-1) |
---|
| 253 | ENDIF |
---|
| 254 | ik = mikt(ji,jj) |
---|
| 255 | IF( ik > 1 ) THEN |
---|
| 256 | zl = ( fsdept_n(ji,jj,ik) - gdept_1d(ik) ) / ( gdept_1d(ik+1) - gdept_1d(ik) ) |
---|
| 257 | ztrcdta(ji,jj,ik) = (1.-zl) * ztrcdta(ji,jj,ik) + zl * ztrcdta(ji,jj,ik+1) |
---|
| 258 | ENDIF |
---|
[3294] | 259 | END DO |
---|
[6793] | 260 | END DO |
---|
| 261 | ENDIF |
---|
[3294] | 262 | ! |
---|
| 263 | ENDIF |
---|
| 264 | ! |
---|
[6793] | 265 | ! Add multiplicative factor |
---|
| 266 | ztrcdta(:,:,:) = ztrcdta(:,:,:) * ptrfac |
---|
| 267 | ! |
---|
| 268 | ! Data structure for trc_ini (and BFMv5.1 coupling) |
---|
| 269 | IF( .NOT. PRESENT(ptrc) ) sf_dta(1)%fnow(:,:,:) = ztrcdta(:,:,:) |
---|
| 270 | ! |
---|
| 271 | ! Data structure for trc_dmp |
---|
| 272 | IF( PRESENT(ptrc) ) ptrc(:,:,:) = ztrcdta(:,:,:) |
---|
| 273 | ! |
---|
[3294] | 274 | IF( lwp .AND. kt == nit000 ) THEN |
---|
[4230] | 275 | clndta = TRIM( sf_dta(1)%clvar ) |
---|
[3294] | 276 | WRITE(numout,*) ''//clndta//' data ' |
---|
[335] | 277 | WRITE(numout,*) |
---|
[3294] | 278 | WRITE(numout,*)' level = 1' |
---|
[6793] | 279 | CALL prihre( ztrcdta(:,:,1), jpi, jpj, 1, jpi, 20, 1, jpj, 20, 1., numout ) |
---|
[3294] | 280 | WRITE(numout,*)' level = ', jpk/2 |
---|
[6793] | 281 | CALL prihre( ztrcdta(:,:,jpk/2), jpi, jpj, 1, jpi, 20, 1, jpj, 20, 1., numout ) |
---|
[3294] | 282 | WRITE(numout,*)' level = ', jpkm1 |
---|
[6793] | 283 | CALL prihre( ztrcdta(:,:,jpkm1), jpi, jpj, 1, jpi, 20, 1, jpj, 20, 1., numout ) |
---|
[3294] | 284 | WRITE(numout,*) |
---|
[945] | 285 | ENDIF |
---|
[6793] | 286 | ! |
---|
| 287 | CALL wrk_dealloc( jpi, jpj, jpk, ztrcdta ) |
---|
| 288 | ! |
---|
[3294] | 289 | ENDIF |
---|
[4230] | 290 | ! |
---|
[3294] | 291 | IF( nn_timing == 1 ) CALL timing_stop('trc_dta') |
---|
[945] | 292 | ! |
---|
[11738] | 293 | IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle) |
---|
[1011] | 294 | END SUBROUTINE trc_dta |
---|
[268] | 295 | #else |
---|
| 296 | !!---------------------------------------------------------------------- |
---|
[945] | 297 | !! Dummy module NO 3D passive tracer data |
---|
[268] | 298 | !!---------------------------------------------------------------------- |
---|
| 299 | CONTAINS |
---|
[6793] | 300 | SUBROUTINE trc_dta( kt, sf_dta, ptrfac, ptrc) ! Empty routine |
---|
[11738] | 301 | INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0 |
---|
| 302 | INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1 |
---|
| 303 | REAL(KIND=jprb) :: zhook_handle |
---|
| 304 | |
---|
| 305 | CHARACTER(LEN=*), PARAMETER :: RoutineName='TRC_DTA' |
---|
| 306 | |
---|
| 307 | IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle) |
---|
| 308 | |
---|
[1011] | 309 | WRITE(*,*) 'trc_dta: You should not have seen this print! error?', kt |
---|
[11738] | 310 | IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle) |
---|
[1011] | 311 | END SUBROUTINE trc_dta |
---|
[268] | 312 | #endif |
---|
[945] | 313 | !!====================================================================== |
---|
[268] | 314 | END MODULE trcdta |
---|