Skip to content
Snippets Groups Projects
ch_emission_fluxn.F90 15.3 KiB
Newer Older
  • Learn to ignore specific revisions
  • 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
    !     #########
          SUBROUTINE CH_EMISSION_FLUX_n(HPROGRAM,PSIMTIME,PSFSV, PRHOA, PTSTEP, KNBTS_MAX)
    !     ######################################################################
    !!
    !!***  *CH_EMISSION_FLUX_n* - 
    !!
    !!    PURPOSE
    !!    -------
    !!      Return a time-dependent emission flux based on tabulated values
    !!
    !!**  METHOD
    !!    ------
    !!
    !!    AUTHOR
    !!    ------
    !!    D. Gazen
    !!
    !!    MODIFICATIONS
    !!    -------------
    !!    Original 08/02/00
    !!    C. Mari  30/10/00 call to MODD_TYPE_EFUTIL and MODD_CST
    !!    D.Gazen  01/12/03  change emissions handling for surf. externalization
    !!    P.Tulet  01/01/04  change emission conversion factor
    !!    P.Tulet  01/01/05  add dust, orilam
    !!    M.Leriche    2015  suppress ZDEPOT
    !!    M.Moge    01/2016  using READ_SURF_FIELD2D for 2D surfex fields reads
    !!
    !!    EXTERNAL
    !!    --------
    !!
    !!
    !!    IMPLICIT ARGUMENTS
    !!    ------------------
    USE MODD_SV_n,             ONLY: CSV,NSV_CHSBEG,NSV_CHSEND, NSV_AERBEG,  NSV_AEREND
    USE MODD_TYPE_EFUTIL,      ONLY: EMISSVAR_T, PRONOSVAR_T
    USE MODD_CSTS,             ONLY: NDAYSEC
    USE MODD_CH_EMIS_FIELD_n,  ONLY: TSEMISS, TSPRONOSLIST, XTIME_SIMUL
    USE MODD_CH_SURF_n,        ONLY: XCONVERSION
    !
    USE MODI_READ_SURF_FIELD2D
    USE MODI_INIT_IO_SURF_n
    USE MODI_END_IO_SURF_n
    USE MODI_GET_LUOUT
    !UPG*AERO1
    USE MODD_CHS_AEROSOL, ONLY: LCH_AERO_FLUX
    USE MODI_CH_AER_EMISSION
    !UPG*AERO1
    !!
    !------------------------------------------------------------------------------
    !
    !*       0.   DECLARATIONS
    !        -----------------
    !
    USE YOMHOOK   ,ONLY : LHOOK,   DR_HOOK
    USE PARKIND1  ,ONLY : JPRB
    !
    USE MODI_ABOR1_SFX
    !
    IMPLICIT NONE
    !
    !*       0.1  declaration of arguments
    !
    CHARACTER(LEN=6),   INTENT(IN)  :: HPROGRAM    ! program calling surf. schemes
    REAL,               INTENT(IN)  :: PSIMTIME    ! time of simulation in sec UTC
                                                   ! (counting from midnight of
                                                   ! the current day)
    REAL,DIMENSION(:,:),  INTENT(INOUT) :: PSFSV   ! emission flux in ppp*m/s
    REAL, DIMENSION(:),   INTENT(IN)    :: PRHOA     ! air density (kg/m3)
    REAL,                 INTENT(IN)    :: PTSTEP    ! atmospheric time-step                 (s)
    INTEGER,              INTENT(IN)    :: KNBTS_MAX !max size of TEMISS%NETIMES
    
    !
    !*       0.2  declaration of local variables
    !
    INTEGER       :: IVERB   ! verbosity level
    INTEGER       :: KSIZE1D ! 1D size = X*Y physical domain 
    INTEGER       :: JI      ! loop control
    REAL          :: ZALPHA  ! interpolation weight
    !
    INTEGER :: INBTS       ! Number of emission times for a species
    INTEGER :: ITIM1,ITIM2 ! first/last time for interpolation
    INTEGER :: INDX1,INDX2 ! first/next index for data interpolation
    INTEGER :: ISIMTIME, ITPERIOD
    CHARACTER (LEN=16)  :: YRECFM          ! LFI article name
    TYPE(PRONOSVAR_T),POINTER :: CURPRONOS !Current pronostic variable
    !
    !*       0.3  declaration of saved local variables
    !
    CHARACTER(LEN=6), DIMENSION(:), POINTER :: CNAMES
    REAL,DIMENSION(SIZE(PSFSV,1),KNBTS_MAX)     :: ZWORK ! temporary array for reading data
    REAL,DIMENSION(SIZE(PSFSV,1),SIZE(PSFSV,2)) :: ZEMIS ! interpolated in time emission flux
    REAL,DIMENSION(SIZE(PSFSV,1))               :: ZFCO  ! CO flux
    INTEGER                          :: INEQ  ! number of chemical var
                                              !(=NEQ (chimie gaz) + NSV_AER (chimie aerosol)
    INTEGER                          :: IWS   ! window size
    INTEGER                          :: IRESP ! return code for I/O
    INTEGER                          :: ILUOUT ! Outputlisting unit
    LOGICAL                          :: LIOINIT ! True if I/O init done
    INTEGER                          :: JW
    INTEGER                          :: ITIME
    LOGICAL                          :: GCO = .FALSE. ! switch if CO emission are available
    REAL(KIND=JPRB) :: ZHOOK_HANDLE
    !
    !------------------------------------------------------------------------------
    !
    !*    EXECUTABLE STATEMENTS
    !     ---------------------
    !
    IF (LHOOK) CALL DR_HOOK('CH_EMISSION_FLUX_N',0,ZHOOK_HANDLE)
    CALL GET_LUOUT(HPROGRAM,ILUOUT)
    LIOINIT = .FALSE.
    IVERB   = 5
    KSIZE1D = SIZE(PSFSV,1)
    INEQ    = SIZE(PSFSV,2)
    !
    !------------------------------------------------------------------------------
    !
    !*    3.  INTERPOLATE SURFACE FLUXES IN TIME IF NEEDED
    !     ------------------------------------------------
    !
    IF (XTIME_SIMUL == 0.) THEN
       XTIME_SIMUL = PSIMTIME
    ELSE
       XTIME_SIMUL = XTIME_SIMUL + PTSTEP
    END IF
    
    IF (IVERB >= 5) WRITE(ILUOUT,*) '******** CH_EMISSION_FLUX  ********'
    DO JI=1,SIZE(TSEMISS)
    ! Simulation time (counting from midnight) is saved
      ISIMTIME = XTIME_SIMUL
    !
      INBTS = SIZE(TSEMISS(JI)%NETIMES) ! 
      IWS   = TSEMISS(JI)%NWS           ! Window Size for I/O
      INDX1 = TSEMISS(JI)%NDX           ! Current data index
    !
      IF (INBTS == 1) THEN
    !   Time Constant Flux
    !   XFWORK already points on data (see build_emisstabn.F90)
        IF (IVERB >= 6) THEN
          WRITE(ILUOUT,*) 'NO interpolation for ',TRIM(TSEMISS(JI)%CNAME)
          IF (IVERB >= 10 ) WRITE(ILUOUT,*) TSEMISS(JI)%XFWORK
        END IF
      ELSE
        IF (IVERB >= 6) THEN
          WRITE(ILUOUT,*) 'Interpolation (T =',ISIMTIME,') : ',TSEMISS(JI)%CNAME
        END IF
        IF (ISIMTIME < TSEMISS(JI)%NETIMES(1)) THEN
    !     Tsim < T(1)=Tmin should not happen but who knows ?
          TSEMISS(JI)%NTX = 1
        ELSE
    !     Check for periodicity when ISIMTIME is beyond last emission time
    !     and probably correct ISIMTIME
          IF (ISIMTIME > TSEMISS(JI)%NETIMES(INBTS)) THEN 
    !       Tsim > T(INBTS)=Tmax
            ITPERIOD = (1+(TSEMISS(JI)%NETIMES(INBTS)-&
                    TSEMISS(JI)%NETIMES(TSEMISS(JI)%NPX))/NDAYSEC)*NDAYSEC  
            ISIMTIME = MODULO(ISIMTIME-TSEMISS(JI)%NETIMES(TSEMISS(JI)%NPX),ITPERIOD)+&
                    TSEMISS(JI)%NETIMES(TSEMISS(JI)%NPX)  
            IF (IVERB >= 6) THEN
              WRITE(ILUOUT,*) '  ITPERIOD = ', ITPERIOD
              WRITE(ILUOUT,*) '  ISIMTIME modifie = ', ISIMTIME
            END IF
            IF (TSEMISS(JI)%NTX == INBTS .AND. ISIMTIME<TSEMISS(JI)%NETIMES(INBTS)) THEN
    !         Update time index NTX 
              TSEMISS(JI)%NTX = TSEMISS(JI)%NPX
    !         Increment data index NDX : NDX correction will occur later
    !                                    to assure 1 <= NDX <= IWS
              INDX1 = INDX1 + 1
            END IF
          END IF
    !
    !     search NTX such that : ETIMES(NTX) < ISIMTIME <= ETIMES(NTX+1)
    !     and make NDX follow NTX : NDX correction will occur later
    !                               to assure 1 <= NDX <= IWS
          DO WHILE (TSEMISS(JI)%NTX < INBTS)
            IF (ISIMTIME >= TSEMISS(JI)%NETIMES(TSEMISS(JI)%NTX+1)) THEN
              TSEMISS(JI)%NTX = TSEMISS(JI)%NTX + 1
              INDX1 = INDX1 + 1
              INDX2 = INDX1 + 1
            ELSE
              EXIT
            END IF
          END DO
        END IF
    !
    !   Check availability of data within memory Window (XEMISDATA(:,1:IWS))
        IF (INDX1 >= IWS) THEN
    !
    !     Data index reached the memory window limits
    !
          IF (TSEMISS(JI)%LREAD) THEN 
    !
    !       File must be read to update XEMISDATA array for this species 
    !
            IF (.NOT. LIOINIT) THEN
    !         Must be done once before reading
              CALL INIT_IO_SURF_n(HPROGRAM,'FULL  ','SURF  ','READ ')
              IF (IVERB >= 6) WRITE(ILUOUT,*) 'INIT des I/O DONE.'
              LIOINIT=.TRUE.
            END IF
            YRECFM='E_'//TRIM(TSEMISS(JI)%CNAME)
            IF (IVERB >= 6)&
                   WRITE (ILUOUT,*) 'READ emission :',TRIM(YRECFM),&
                   ', SIZE(ZWORK)=',SIZE(ZWORK,1),INBTS 
            CALL READ_SURF_FIELD2D(HPROGRAM,ZWORK(:,1:INBTS),YRECFM)
    !
    ! Correction : Replace 999. with 0. value in the Emission FLUX
            WHERE(ZWORK(:,1:INBTS) == 999.)
              ZWORK(:,1:INBTS) = 0. 
            END WHERE
            WHERE(ZWORK(:,1:INBTS) == 1.E20)
              ZWORK(:,1:INBTS) = 0. 
            END WHERE
            DO ITIME=1,INBTS
            ZWORK(:,ITIME) = ZWORK(:,ITIME)*XCONVERSION(:)
            END DO
    !
    !       
            IF ((TSEMISS(JI)%NTX+IWS-1) > INBTS) THEN
    !
    !         ===== Periodic CASE =====
    !
              IF (IVERB >= 6)&
                     WRITE (ILUOUT,*) 'Periodic CASE : NPX =',TSEMISS(JI)%NPX  
              IF (IWS <  (INBTS-TSEMISS(JI)%NPX+1)) THEN
    !           Window size is smaller then number of periodical times
    !
    !           example : IWS=5, NPX=2, INBTS=11, NTX=9
    !                               NTX       NPX
    !                                |         |
    !           time index :      ...9 10 11 # 2 3 4...11 #
    !       old data index :[1 2 3 4 5] 
    !       new data index :        [1  2  3   4 5]
    !                                |  
    !                               NDX    
    !
                TSEMISS(JI)%XEMISDATA(:,1:INBTS-TSEMISS(JI)%NTX+1) = &
                       ZWORK(:,TSEMISS(JI)%NTX:INBTS)  
    !
                IF (IVERB >= 6) THEN
                  WRITE(ILUOUT,*) 'Window SIZE smaller than INBTS !'
                  WRITE(ILUOUT,*) 'Window index, Time index'
                  DO JW=1,INBTS-TSEMISS(JI)%NTX+1
                    WRITE(ILUOUT,*) JW,TSEMISS(JI)%NTX+JW-1
                  END DO
                END IF
    !
                TSEMISS(JI)%XEMISDATA(:,INBTS-TSEMISS(JI)%NTX+2:IWS) = &
                       ZWORK(:,TSEMISS(JI)%NPX:TSEMISS(JI)%NPX+IWS-INBTS+TSEMISS(JI)%NTX-2)  
    !
                IF (IVERB >= 6) THEN
                  DO JW=INBTS-TSEMISS(JI)%NTX+2,IWS
                    WRITE(ILUOUT,*) JW,TSEMISS(JI)%NPX+JW-(INBTS-TSEMISS(JI)%NTX+2)
                  END DO
                END IF
                INDX1 = 1
                INDX2 = 2
              ELSE
    !           Window size may get smaller AND it will be the last reading
    !
    !           example : IWS=6, NPX=7, INBTS=11, NTX=9
    !
    !                         NTX       NPX NTX
    !                          |         |   |
    !           time index: ...9 10 11 # 7 8 9 10 11 #
    !       old data index: ...6]
    !       new data index:             [1 2 3  4  5]
    !                                        |
    !                                       NDX=NTX-NPX+1
    !
                IWS = INBTS-TSEMISS(JI)%NPX+1
                TSEMISS(JI)%NWS = IWS
                TSEMISS(JI)%XEMISDATA(:,1:IWS) = ZWORK(:,TSEMISS(JI)%NPX:INBTS)
                IF (IVERB >= 6) THEN
                  WRITE(ILUOUT,*) 'Window SIZE equal or greater than INBTS !'
                  WRITE(ILUOUT,*) 'Window index, Time index'
                  DO JW=1,IWS
                    WRITE(ILUOUT,*) JW,TSEMISS(JI)%NPX+JW-1
                  END DO
                END IF
                INDX1 = TSEMISS(JI)%NTX-TSEMISS(JI)%NPX+1
                INDX2 = MOD((INDX1+1),IWS)
                TSEMISS(JI)%LREAD = .FALSE. ! no more reading
              END IF
            ELSE
    !
    !         ===== NON periodic (normal) CASE =====
    !
    ! example : with IWS=5, the window moves forward
    !                             NTX
    !                              | 
    !         time index : 1 2 3 4 5 6 7 8 9 10 11 ... INBTS # 
    !     old data index :[1 2 3 4 5] 
    !     new data index :        [1 2 3 4 5] 
    !                              |
    !                             NDX
    !
              TSEMISS(JI)%XEMISDATA(:,1:IWS) = ZWORK(:,TSEMISS(JI)%NTX:TSEMISS(JI)%NTX+IWS-1)
              IF (IVERB >= 6) THEN
                WRITE(ILUOUT,*) 'Window index, Time index'
                DO JW=1,IWS
                  WRITE(ILUOUT,*) JW,TSEMISS(JI)%NTX+JW-1
                END DO
              END IF
              INDX1 = 1
              INDX2 = 2
            END IF
          ELSE
    !       Data is already in memory because window size is sufficient 
    !       to hold INBTS emission times => simply update NDX according to NTX
    !       
            IF (IWS==INBTS) THEN 
    !
    !         'Window size' = 'Nb emis times' at INIT (ch_init_emission)
    !         so NDX must be set equal to NTX (the window does not move)
    ! example :
    !                         NPX    NTX
    !                          |      | 
    !         time index :  1  2  3  ... INBTS
    !         data index : [1  2  3  ... INBTS]
    !                                 |
    !                                NDX
    
              INDX1 = TSEMISS(JI)%NTX
              INDX2 = INDX1+1
              IF (INDX2 > IWS) INDX2=TSEMISS(JI)%NPX
            ELSE
    !          
    !         Windows size changed during periodic case
    !         NDX must be equal to NTX - NPX + 1
    !         (the window does not move)
    ! example :
    !                                NTX
    !                                 | 
    !         time index : NPX NPX+1 NPX+2 ... INBTS
    !         data index : [1    2    3    ...   IWS]
    !                                 |
    !                                NDX
              INDX1 = TSEMISS(JI)%NTX-TSEMISS(JI)%NPX+1
              INDX2 = MOD((INDX1+1),IWS)
            END IF
          END IF
        ELSE ! (INDX1 < IWS)
          INDX2 = INDX1+1
        END IF
    !
    !   Don't forget to update NDX with new value INDX1
        TSEMISS(JI)%NDX = INDX1
    !
    !   Compute both times for interpolation
        IF (TSEMISS(JI)%NTX < INBTS) THEN 
          ITIM1 = TSEMISS(JI)%NETIMES(TSEMISS(JI)%NTX)
          ITIM2 = TSEMISS(JI)%NETIMES(TSEMISS(JI)%NTX+1)
        ELSE
          ITIM1 = TSEMISS(JI)%NETIMES(INBTS)
          ITIM2 = TSEMISS(JI)%NETIMES(TSEMISS(JI)%NPX)+ITPERIOD
        END IF
    !
    ! Interpolate variables in time -> update XFWORK
    !
    !
    !  time       :  ITIM1...Tsim...ITIM2
    !                  |              |  
    !  data index :  INDX1          INDX2
    !
    !
        ZALPHA = (REAL(ISIMTIME) - ITIM1) / (ITIM2-ITIM1)
        TSEMISS(JI)%XFWORK(:) = ZALPHA*TSEMISS(JI)%XEMISDATA(:,INDX2) +&
                (1.-ZALPHA)*TSEMISS(JI)%XEMISDATA(:,INDX1)  
        IF (IVERB >= 6) THEN
          WRITE(ILUOUT,*) '  Current time INDEX : ',TSEMISS(JI)%NTX
          WRITE(ILUOUT,*) '  TIME : ',ISIMTIME, ' (',ITIM1,',',ITIM2,')'
          WRITE(ILUOUT,*) '  Window size : ',TSEMISS(JI)%NWS
          WRITE(ILUOUT,*) '  Current data INDEX : ',INDX1,INDX2
          IF (IVERB >= 10) WRITE(ILUOUT,*) '  FLUX : ',TSEMISS(JI)%XFWORK
        END IF
      END IF
    END DO
    ! 
    ! Agregation : flux computation
    !
    ZEMIS(:,:) = 0.
    !
    ! Point on head of Pronostic variable list
    ! to cover the entire list.
    IF (NSV_AEREND > 0) THEN
    CNAMES=>CSV(NSV_CHSBEG:NSV_AEREND)
    ELSE
    CNAMES=>CSV(NSV_CHSBEG:NSV_CHSEND)
    END IF
    CURPRONOS=>TSPRONOSLIST
    DO WHILE(ASSOCIATED(CURPRONOS))
      IF (CURPRONOS%NAMINDEX > INEQ) THEN
        WRITE(ILUOUT,*) 'FATAL ERROR in CH_EMISSION_FLUXN : SIZE(ZEMIS,2) =',&
               INEQ,', INDEX bugge =',CURPRONOS%NAMINDEX  
        CALL ABOR1_SFX('CH_EMISSION_FLUXN: FATAL ERROR')
      END IF
      
      ZEMIS(:,CURPRONOS%NAMINDEX) = 0.
    !
    ! Loop on the number of agreg. coeff.
      DO JI=1,CURPRONOS%NBCOEFF
    !   Compute agregated flux    
        ZEMIS(:,CURPRONOS%NAMINDEX) = ZEMIS(:,CURPRONOS%NAMINDEX)+&
                CURPRONOS%XCOEFF(JI)*TSEMISS(CURPRONOS%NEFINDEX(JI))%XFWORK(:)  
      END DO
    
      IF (IVERB >= 6) THEN
        WRITE(ILUOUT,*) 'Agregation for ',CNAMES(CURPRONOS%NAMINDEX)
        IF (IVERB >= 10) WRITE(ILUOUT,*) 'ZEMIS = ',ZEMIS(:,CURPRONOS%NAMINDEX)
      END IF
      IF ((CNAMES(CURPRONOS%NAMINDEX) == "CO") .AND. ANY(ZEMIS(:,CURPRONOS%NAMINDEX).GT.0.)) THEN
      ZFCO(:) = ZEMIS(:,CURPRONOS%NAMINDEX)
      GCO = .TRUE.
      END IF
    
      CURPRONOS=>CURPRONOS%NEXT
    !
    END DO
    !
    IF ((LCH_AERO_FLUX).AND.(NSV_AERBEG > 0)) THEN
      IF (GCO) THEN
        CALL CH_AER_EMISSION(ZEMIS, PRHOA, CSV, NSV_CHSBEG, PFCO=ZFCO)
      ELSE
        CALL CH_AER_EMISSION(ZEMIS, PRHOA, CSV, NSV_CHSBEG)
      ENDIF
    END IF
    !
    PSFSV(:,:) = PSFSV(:,:) + ZEMIS(:,:)
    !
    IF (LIOINIT) CALL END_IO_SURF_n(HPROGRAM)
    !
    IF (IVERB >= 6) WRITE(ILUOUT,*) '******** END CH_EMISSION_FLUX  ********'
    IF (LHOOK) CALL DR_HOOK('CH_EMISSION_FLUX_N',1,ZHOOK_HANDLE)
    !
    END SUBROUTINE CH_EMISSION_FLUX_n