source: trunk/LMDZ.GENERIC/libf/aeronostd/photochemistry_asis.F90 @ 3469

Last change on this file since 3469 was 3312, checked in by yjaziri, 8 months ago

Generic PCM:

Photochemistry: correction for using diurnal equal true in 1D
No correction factor with diurnal equal true for photolysis rate
+ writediagspecUV change name to flux_surf for clarity

YJ

  • Property svn:executable set to *
File size: 57.1 KB
RevLine 
[1796]1!*****************************************************************
2!
3!     Photochemical routine
4!
5!     Author: Franck Lefevre
[2542]6!             Benjamin Charnay
7!             Yassin Jaziri
[1796]8!     ------
9!
[2542]10!     Version: 27/05/2016
11!     update 06/03/2021 generic tracer/network + photolysis online (Yassin Jaziri)
[1796]12!
13!*****************************************************************
14
[2542]15subroutine photochemistry_asis(nlayer, ngrid,                                   &
[1796]16                          ig, lswitch, zycol, sza, fractcol, ptimestep, press,  &
[2542]17                          alt, temp, dens, zmmean, dist_sol, surfdust1d,        &
18                          surfice1d, tau, iter,zdtchim)
[1796]19
20      use callkeys_mod
[2542]21      use comcstfi_mod, only:  r,cpp,avocado,pi
22      use tracer_h
23      use types_asis
24      use chimiedata_h
25      use photolysis_mod
26
[1796]27implicit none
28
29!===================================================================
30!     inputs:
31!===================================================================
32
33integer, intent(in) :: nlayer ! number of atmospheric layers
[2542]34integer, intent(in) :: ngrid  ! number of atmospheric columns
35
[1796]36integer :: ig                 ! grid point index
37     
38real :: sza                   ! solar zenith angle (deg)
39real :: fractcol              ! day fraction
40real :: ptimestep             ! physics timestep (s)
41real :: press(nlayer)         ! pressure (hpa)
[2542]42real :: alt(nlayer)           ! altitude (km)
[1796]43real :: temp(nlayer)          ! temperature (k)
44real :: dens(nlayer)          ! density (cm-3)
45real :: zmmean(nlayer)        ! mean molar mass (g/mole)
46real :: dist_sol              ! sun distance (au)
47real :: surfdust1d(nlayer)    ! dust surface area (cm2/cm3)
48real :: surfice1d(nlayer)     ! ice surface area (cm2/cm3)
49real :: tau                   ! optical depth at 7 hpa
50
51!===================================================================
52!     input/output:
53!===================================================================
54     
[2542]55real :: zycol(nlayer,nesp)    ! chemical species volume mixing ratio
[1796]56
57!===================================================================
58!     output:
59!===================================================================
60     
[2542]61integer :: iter(nlayer)       ! iteration counter
62real    :: zdtchim(nlayer)    ! temperature modification by ozone
[1796]63
64!===================================================================
65!     local:
66!===================================================================
67
68integer :: phychemrat         ! (physical timestep)/(nominal chemical timestep)
[2542]69integer :: ilev, iesp, iphot, iw
[1796]70integer :: lswitch
71
72logical, save :: firstcall = .true.
73
74real :: stimestep           ! standard timestep for the chemistry (s)
75real :: ctimestep           ! real timestep for the chemistry (s)
76real :: dt_guess            ! first-guess timestep (s)
77real :: dt_corrected        ! corrected timestep (s)
78real :: dt_min = 1.         ! minimum allowed timestep (s)
79real :: dtg                 ! correction factor for the timestep (s)
80real :: j(nlayer,nd)        ! interpolated photolysis rates (s-1)
81real :: time                ! internal time (between 0 and ptimestep, in s)
[2542]82real :: rho(nlayer)         ! mass density (kg/m-3)
[1796]83
84real, dimension(nlayer,nesp)            :: rm   ! mixing ratios
85real (kind = 8), dimension(nesp)        :: cold ! number densities at previous timestep (molecule.cm-3)
86real (kind = 8), dimension(nlayer,nesp) :: c    ! number densities at current timestep (molecule.cm-3)
87real (kind = 8), dimension(nesp)        :: cnew ! number densities at next timestep (molecule.cm-3)
88 
89! reaction rates
90 
[2542]91real (kind = 8), allocatable, save     :: v_phot(:,:)
92real (kind = 8), allocatable, save     :: v_3(:,:)
93real (kind = 8), allocatable, save     :: v_4(:,:)
94real (kind = 8), allocatable, save     :: e_phot(:,:)    ! photolysis rates by energie (J.mol-1.s-1)
[1796]95
[2542]96integer, save                          :: nreact         ! number of reactions in reactions files
97
[1796]98! matrix
99
[2542]100real (kind = 8), dimension(nesp,nesp)  :: mat, mat1
101integer, dimension(nesp)               :: indx
102integer                                :: code
[1796]103
104! production and loss terms (for first-guess solution only)
105
[2542]106real (kind = 8), dimension(nesp)       :: prod, loss
[1796]107
108!===================================================================
109!     initialisation of the reaction indexes
110!===================================================================
111
112if (firstcall) then
113   print*,'photochemistry: initialize indexes'
[2553]114   call indice(nreact)
[2542]115   allocate(v_phot(nlayer,nb_phot_max))
116   allocate(v_3(nlayer,nb_reaction_3_max))
117   allocate(v_4(nlayer,nb_reaction_4_max))
118   allocate(v_phot_3d(ngrid,nlayer,nb_phot_hv_max))
119   allocate(e_phot(nlayer,nb_phot_max))
120   v_phot(:,:)      = 0.
121   v_3(:,:)         = 0.
122   v_4(:,:)         = 0.
123   v_phot_3d(:,:,:) = 0.
124   e_phot(:,:)      = 0.
125
126   ! Need to be done after subroutine indice
127   if (jonline) then
128     print*,'calchim: Read UV absorption cross-sections'
129     ! Jonline cannot run without photolysis
130     if (nb_phot_hv_max == 0) then
131       print*,'Jonline cannot run without photolysis'
132       print*,'set jonline=.false. in callphys.def'
133       print*,'or set photolysis reactions in monoreact file'
[2553]134       call abort
[2542]135     end if
[2553]136     call init_photolysis(nlayer,nreact)     ! on-line photolysis
[2542]137     allocate(albedo_snow_chim(nw))
138     allocate(albedo_co2_ice_chim(nw))
[3309]139     allocate(fluxUV(ngrid,nw,nlayer))
140     fluxUV(:,:,:) = 0.
[2542]141    ! Step 1 : Initialisation of the Spectral Albedos.
142     DO iw=1,nw
143      albedo_snow_chim(iw)=albedosnow
144      albedo_co2_ice_chim(iw)=albedoco2ice
145
146      ! Spectral Snow Albedo Calculation.
147      call albedo_snow_calc(wc(iw)*1.0e-3,        &
148                     albedo_snow_chim(iw),  &
149                     albedosnow)
150     
151     ENDDO
152   end if
153
[1796]154   firstcall = .false.
155end if
156
157!===================================================================
158!     initialisation of mixing ratios and densities       
159!===================================================================
160
[2542]161call gcmtochim(nlayer, zycol, lswitch, nesp, dens, rm, c)
[1796]162
163!===================================================================
164!     interpolation of photolysis rates in the lookup table     
165!===================================================================
166
[2542]167if (jonline) then
168   if (sza <= 95.) then
169      call photolysis_online(nlayer, alt, press, temp, zmmean, rm,   &
[2553]170                             tau, sza, dist_sol, v_phot, e_phot, ig, ngrid, nreact)
[3312]171      if (diurnal .eqv. .false.) then
172        if (ngrid.eq.1) then
173          do iphot = 1,nb_phot_hv_max
174            v_phot(:,iphot) = v_phot(:,iphot)* 0.25 / cos(sza*pi/180.) ! globally averaged = divide by 4
175            e_phot(:,iphot) = e_phot(:,iphot)* 0.25 / cos(sza*pi/180.) ! globally averaged = divide by 4
176          end do
177        else
178          do iphot = 1,nb_phot_hv_max
179            v_phot(:,iphot) = v_phot(:,iphot) * fractcol
180            e_phot(:,iphot) = e_phot(:,iphot) * fractcol
181          end do
182        endif
[2542]183      endif
184   else ! night
185      v_phot(:,:) = 0.
186      e_phot(:,:) = 0.
187   end if
188   ! save photolysis for output
189   v_phot_3d(ig,:,:) = v_phot(:,1:nb_phot_hv_max)
190else if (nb_phot_hv_max /= 0) then
191   call photolysis_asis(nlayer, ngrid, lswitch, press, temp, sza, fractcol,tau, zmmean, dist_sol, &
192                     rm(:,indexchim('co2')), rm(:,indexchim('o3')), rm(:,indexchim('ch4')), v_phot)
193   ! save photolysis for output
194   v_phot_3d(ig,:,:) = v_phot(:,1:nb_phot_hv_max)
195end if
[1796]196
[2542]197!===================================================================
198!     reaction rates                                     
199!===================================================================
[1796]200
[2553]201call reactionrates(nlayer, nreact, c, lswitch, dens, &
[2542]202                   press, temp, zmmean, sza, surfdust1d, surfice1d, v_phot, v_3, v_4)
[1796]203
[2542]204zdtchim(:) = 0.
205rho(:)     = (press(:)*1e2)/(r*temp(:))
206
[1796]207!===================================================================
[2542]208!     temperature modification by photolysis reaction                                   
[1796]209!===================================================================
210
[2542]211if (photoheat .and. jonline) then ! for now just with jonline
[1796]212
[2542]213  do iphot = 1,nb_phot_hv_max
214    zdtchim(:nlayer-1) = zdtchim(:nlayer-1) + e_phot(:nlayer-1,iphot)*c(:nlayer-1,indexchim(trim(jlabel(iphot,2))))/(cpp*(rho(:nlayer-1)*1e-6)*avocado)
215  end do
[1796]216
[2542]217else
218
219!! o + o2 -> o3
220!!dE = 24 ! kcal.mol-1
221!!zdtchim(:) = zdtchim(:) + 4.184*24e3*v_4(:,1)*c(:,indexchim('o'))*c(:,indexchim('o2'))*1e6/(cpp*rho*avocado)
222!
223!! o3 -> o2 + o1d
224!! E(250nm) = 480 kJ.mol-1
225!j_o3_o1d   = 3
226!zdtchim(:) = zdtchim(:) + 480e3*v_phot(:,j_o3_o1d)*c(:,indexchim('o3'))/(cpp*(rho*1e-6)*avocado)
227!
228!! o3 -> o2 + o
229!! E(350nm) = 343 kJ.mol-1
230!j_o3_o     = 4
231!zdtchim(:) = zdtchim(:) + 343e3*v_phot(:,j_o3_o)*c(:,indexchim('o3'))/(cpp*(rho*1e-6)*avocado)
232
233zdtchim(:) = 0.
234
235end if
236
[1796]237!===================================================================
238!     stimestep : standard chemical timestep (s)                           
239!     ctimestep : real chemical timestep (s),
240!                 taking into account the physical timestep                           
241!===================================================================
242
243stimestep = 600. ! standard value : 10 mn
244
245phychemrat = nint(ptimestep/stimestep)
246phychemrat = 1
247
248ctimestep = ptimestep/real(phychemrat)
249
250!===================================================================
251!     loop over levels         
252!===================================================================
253
254do ilev = 1,lswitch - 1
255
256!  initializations
257
258   time = 0.
259   iter(ilev) = 0
260   dt_guess = ctimestep
261   cold(:) = c(ilev,:)
262
263!  internal loop for the chemistry
264
265   do while (time < ptimestep)
266
267   iter(ilev) = iter(ilev) + 1    ! iteration counter
[2542]268 
[1796]269!  first-guess: fill matrix
270
271   call fill_matrix(ilev, mat1, prod, loss, c, nesp, nlayer, v_phot, v_3, v_4)
272
273!  adaptative evaluation of the sub time step
274
275   call define_dt(nesp, dt_corrected, dt_guess, ctimestep, cold(:), c(ilev,:),  &
276                  mat1, prod, loss, dens(ilev))
277
278   if (time + dt_corrected > ptimestep) then
279      dt_corrected = ptimestep - time
280   end if
281
282!  if (dt_corrected /= dt_guess) then  ! the timestep has been modified
283
284!  form the matrix identity + mat*dt_corrected
285
286   mat(:,:) = mat1(:,:)*dt_corrected
287   do iesp = 1,nesp
288      mat(iesp,iesp) = 1. + mat(iesp,iesp)
289   end do
290
291!  solve the linear system  M*Cn+1 = Cn (RHS in cnew, then replaced by solution)
292
293   cnew(:) = c(ilev,:)
294
295#ifdef LAPACK
296   call dgesv(nesp,1,mat,nesp,indx,cnew,nesp,code)
297#else
[1813]298   write(*,*) "photochemistry_asis error, missing LAPACK routine dgesv"
[2553]299   call abort
[1796]300#endif
301
302!  end if
303
304!  eliminate small values
305
306   where (cnew(:)/dens(ilev) < 1.e-30)
307      cnew(:) = 0.
308   end where
309
310!  update concentrations
311
312   cold(:)   = c(ilev,:)
313   c(ilev,:) = cnew(:)
314   cnew(:)   = 0.
315
316!  increment internal time
317
318   time = time + dt_corrected
319   dt_guess = dt_corrected     ! first-guess timestep for next iteration
320
321   end do ! while (time < ptimestep)
322
323end do ! ilev
324
325!===================================================================
326!     save chemical species for the gcm       
327!===================================================================
328
[2542]329call chimtogcm(nlayer, zycol, lswitch, nesp, dens, c)
[1796]330
331contains
332
333!================================================================
334
335 subroutine define_dt(nesp, dtnew, dtold, ctimestep, cold, ccur, mat1, &
336                      prod, loss, dens)
337
338!================================================================
339! iterative evaluation of the appropriate time step dtnew
340! according to curvature criterion based on
341! e = 2 Rtol [r Cn+1 -(1-r) Cn + Cn-1 ]/[(1+r) Cn]
342! with r = (tn - tn-1)/(tn+1 - tn)
343!================================================================
344
345implicit none
346
347! input
348
349integer :: nesp  ! number of species in the chemistry
350
351real :: dtold, ctimestep
352real (kind = 8), dimension(nesp)      :: cold, ccur
353real (kind = 8), dimension(nesp,nesp) :: mat1
354real (kind = 8), dimension(nesp)      :: prod, loss
355real                                  :: dens
356
357! output
358
359real :: dtnew
360
361! local
362
363real (kind = 8), dimension(nesp)      :: cnew
364real (kind = 8), dimension(nesp,nesp) :: mat
365real (kind = 8) :: atol, ratio, e, es, coef
366
367integer                  :: code, iesp, iter
368integer, dimension(nesp) :: indx
369
370real :: dttest
371
372! parameters
373
374real (kind = 8), parameter :: dtmin   = 10.      ! minimum time step (s)
375real (kind = 8), parameter :: vmrtol  = 1.e-11   ! absolute tolerance on vmr
[2542]376real (kind = 8), parameter :: rtol    = 1./0.05  ! 1/rtol recommended value : 0.1-0.02
[1796]377integer,         parameter :: niter   = 3        ! number of iterations
378real (kind = 8), parameter :: coefmax = 2.
379real (kind = 8), parameter :: coefmin = 0.1
380logical                    :: fast_guess = .true.
381
382dttest = dtold   ! dttest = dtold = dt_guess
383
384atol = vmrtol*dens ! absolute tolerance in molecule.cm-3
385
386do iter = 1,niter
387
388if (fast_guess) then
389
390! first guess : fast semi-implicit method
391
392   do iesp = 1, nesp
393      cnew(iesp) = (ccur(iesp) + prod(iesp)*dttest)/(1. + loss(iesp)*dttest)
394   end do
395
396else
397
398! first guess : form the matrix identity + mat*dt_guess
399
400   mat(:,:) = mat1(:,:)*dttest
401   do iesp = 1,nesp
402      mat(iesp,iesp) = 1. + mat(iesp,iesp)
403   end do
404
405! form right-hand side (RHS) of the system
406
407   cnew(:) = ccur(:)
408
409! solve the linear system  M*Cn+1 = Cn (RHS in cnew, then replaced by solution)
410
411#ifdef LAPACK
412      call dgesv(nesp,1,mat,nesp,indx,cnew,nesp,code)
413#else
414   write(*,*) "photochemistry_asis error, missing LAPACK routine dgesv"
[2553]415   call abort
[1796]416#endif
417
418end if
419
420! ratio old/new subtimestep
421
422ratio = dtold/dttest
423
424! e : local error indicatocitr
425
426e = 0.
427
428do iesp = 1,nesp
429   es = 2.*abs((ratio*cnew(iesp) - (1. + ratio)*ccur(iesp) + cold(iesp))   &
430         /(1. + ratio)/max(ccur(iesp),atol))
431
432   if (es > e) then
433      e = es
434   end if
435end do
436e = rtol*e
437
438! timestep correction
439
[2542]440if (e <= 0.) then
441  coef = coefmax
442else
443  coef = max(coefmin, min(coefmax,0.8/sqrt(e)))
444end if
[1796]445
446dttest = max(dtmin,dttest*coef)
447dttest = min(ctimestep,dttest)
448
449end do ! iter
450
451! new timestep
452
453dtnew = dttest
454
455end subroutine define_dt
456
457
458!======================================================================
459
[2553]460 subroutine reactionrates(nlayer, nreact, c,                    &
[2542]461                          lswitch, dens, press, t, zmmean, sza, &
[1796]462                          surfdust1d, surfice1d,                &
463                          v_phot, v_3, v_4)
464 
465!================================================================
466! compute reaction rates                                        !
467!----------------------------------------------------------------
468! reaction               type                array              !
469!----------------------------------------------------------------
470! A + B    --> C + D     bimolecular         v_4                !
471! A + A    --> B + C     quadratic           v_3                !
472! A + C    --> B + C     quenching           v_phot             !
473! A + ice  --> B + C     heterogeneous       v_phot             !
474!================================================================
475
476use comcstfi_mod
[2542]477use types_asis
478use pfunc
479use tracer_h
480use chimiedata_h
[1796]481
482implicit none
483
484!----------------------------------------------------------------------
485!     input
486!----------------------------------------------------------------------
487
[2542]488integer, intent(in)     :: nlayer             ! number of atmospheric layers
489integer, intent(in)     :: nreact             ! number of reactions in reactions files
490integer                 :: lswitch            ! interface level between lower
491                                              ! atmosphere and thermosphere chemistries
492real, dimension(nlayer) :: dens               ! total number density (molecule.cm-3)
493real, dimension(nlayer) :: press              ! pressure (hPa)
494real, dimension(nlayer) :: t                  ! temperature (K)
495real, dimension(nlayer) :: zmmean             ! mean molar mass (g/mole)
496real                    :: sza                ! solar zenith angle (deg)
497real, dimension(nlayer) :: surfdust1d         ! dust surface area (cm2.cm-3)
498real, dimension(nlayer) :: surfice1d          ! ice surface area (cm2.cm-3)
499real (kind = 8), dimension(nlayer,nesp) :: c  ! species number density (molecule.cm-3)
[1796]500
501!----------------------------------------------------------------------
502!     output
503!----------------------------------------------------------------------
504
505real (kind = 8), dimension(nlayer,      nb_phot_max) :: v_phot
506real (kind = 8), dimension(nlayer,nb_reaction_3_max) :: v_3
507real (kind = 8), dimension(nlayer,nb_reaction_4_max) :: v_4
508
509!----------------------------------------------------------------------
510!     local
511!----------------------------------------------------------------------
512
[2542]513logical,save     :: firstcall = .true.
514integer          :: ilev, ireact
[1796]515integer          :: nb_phot, nb_reaction_3, nb_reaction_4
[2542]516integer          :: nb_hv, nb_pfunc1, nb_pfunc2, nb_pfunc3
517real, dimension(nlayer) :: ratec ! rate coefficient
[1796]518
519!----------------------------------------------------------------------
520!     initialisation
521!----------------------------------------------------------------------
522
[2542]523      nb_phot       = nb_phot_hv_max
[1796]524      nb_reaction_3 = 0
525      nb_reaction_4 = 0
526
[2542]527      nb_hv         = 0
528      nb_pfunc1     = 0
529      nb_pfunc2     = 0
530      nb_pfunc3     = 0
[1796]531
532!----------------------------------------------------------------------
[2542]533!     reactions
[1796]534!----------------------------------------------------------------------
535
[2553]536do ireact = 1,nreact
537  if (reactions(ireact)%rtype==0) then
[2542]538    nb_hv = nb_hv + 1
[2553]539    cycle
[2542]540  end if
[1796]541
[2542]542  ! get right coefficient rate function
[2553]543  if (reactions(ireact)%rtype==1) then
[2542]544    nb_pfunc1 = nb_pfunc1 + 1
[2553]545    if (reactions(ireact)%third_body==0) then            !! third_body check
[2542]546      ratec = pfunc1(nlayer,t,dens,pfunc1_param(nb_pfunc1))
547    else
[2553]548      ratec = pfunc1(nlayer,t,c(:,reactions(ireact)%third_body),pfunc1_param(nb_pfunc1))
[2542]549    end if
[2553]550  else if (reactions(ireact)%rtype==2) then
[2542]551    nb_pfunc2 = nb_pfunc2 + 1
[2553]552    if (reactions(ireact)%third_body==0) then            !! third_body check
[2542]553      ratec = pfunc2(nlayer,t,dens,pfunc2_param(nb_pfunc2))
554    else
[2553]555      ratec = pfunc2(nlayer,t,c(:,reactions(ireact)%third_body),pfunc2_param(nb_pfunc2))
[2542]556    end if
[2553]557  else if (reactions(ireact)%rtype==3) then
[2542]558    nb_pfunc3 = nb_pfunc3 + 1
[2553]559    if (reactions(ireact)%third_body==0) then            !! third_body check
[2542]560      ratec = pfunc3(nlayer,t,dens,pfunc3_param(nb_pfunc3))
561    else
[2553]562      ratec = pfunc3(nlayer,t,c(:,reactions(ireact)%third_body),pfunc3_param(nb_pfunc3))
[2542]563    end if
564  else
[2553]565    print*, 'Error in reactionrates: wrong index coefficient rate vphot'
566    print*, 'rtype(ireact) = ',reactions(ireact)%rtype
[2542]567    print*, 'It should be 1 or 2 '
[2553]568    print*, 'Please check the reaction ',ireact
[2542]569    if (ireact>nreact) print*, 'Please check the reaction count into the code beacause ireact > nreact is not possible'
[2553]570    call abort
[2542]571  end if
[1796]572
[2542]573  ! fill the right type index
[2553]574  if (reactions(ireact)%vtype=="v4") then
[2542]575    nb_reaction_4 = nb_reaction_4 + 1
576    v_4(:,nb_reaction_4) = ratec(:)
[2553]577    if (reactions(ireact)%three_prod) then             ! three_prod check
578      nb_reaction_4 = nb_reaction_4 + 1
579      v_4(:,nb_reaction_4) = ratec(:)
[2542]580    end if
[2553]581  else if (reactions(ireact)%vtype=="v3") then
582    nb_reaction_3 = nb_reaction_3 + 1
583    v_3(:,nb_reaction_3) = ratec(:)
584    if (reactions(ireact)%three_prod) then             ! three_prod check
585      nb_reaction_3 = nb_reaction_3 + 1
586      v_3(:,nb_reaction_3) = ratec(:)
[2542]587    end if
[2553]588  else if (reactions(ireact)%vtype=="vphot") then
589    nb_phot = nb_phot + 1
590    v_phot(:,nb_phot) = ratec(:)
591    if (reactions(ireact)%three_prod) then             ! three_prod check
592      nb_phot = nb_phot + 1
593      v_phot(:,nb_phot) = ratec(:)
[2542]594    end if
595  else
[2553]596    print*, 'Error in reactionrates: wrong type coefficient rate'
597    print*, 'vtype(ireact) = ',reactions(ireact)%vtype
598    print*, 'It should be v4, v3 or vphot '
599    print*, 'Please check the reaction ',ireact
[2542]600    if (ireact>nreact) print*, 'Please check the reaction count into the code beacause ireact > nreact is not possible'
[2553]601    call abort
[2542]602  end if
[1796]603
[2542]604end do
[1796]605
[2542]606call reactionrates_HC(nlayer,nesp,dens,t,press,zmmean,sza,c,v_phot,v_4,v_3,nb_phot,nb_reaction_4,nb_reaction_3)
[1796]607
[2542]608!===========================================================
609!  check dimensions
610!===========================================================
[1796]611
[2542]612if (firstcall) then
613 if ((nb_phot /= nb_phot_max)             .or.  &
614     (nb_reaction_3 /= nb_reaction_3_max) .or.  &
615     (nb_reaction_4 /= nb_reaction_4_max)) then
616    print*, 'nb_phot       = ', nb_phot
617    print*, 'nb_reaction_4 = ', nb_reaction_4
618    print*, 'nb_reaction_3 = ', nb_reaction_3
619    print*, 'wrong dimensions in reactionrates'
620    print*, 'nb_phot_max       = ', nb_phot_max
621    print*, 'nb_reaction_4_max = ', nb_reaction_4_max
622    print*, 'nb_reaction_3_max = ', nb_reaction_3_max
623    print*, '------ hard coding reaction ------'
624    print*, 'nphot_hard_coding = ', nphot_hard_coding
625    print*, 'n4_hard_coding    = ', n4_hard_coding
626    print*, 'n3_hard_coding    = ', n3_hard_coding
[2553]627    call abort
[2542]628 end if
629 if ((nb_hv /= nb_hv_max)         .or.  &
630     (nb_pfunc1 /= nb_pfunc1_max) .or.  &
631     (nb_pfunc2 /= nb_pfunc2_max) .or.  &
632     (nb_pfunc3 /= nb_pfunc3_max)) then
633    print*, 'nb_hv         = ', nb_hv
634    print*, 'nb_pfunc1     = ', nb_pfunc1
635    print*, 'nb_pfunc2     = ', nb_pfunc2
636    print*, 'nb_pfunc3     = ', nb_pfunc3
637    print*, 'wrong dimensions in reactionrates'
638    print*, 'nb_hv_max     = ', nb_hv_max
639    print*, 'nb_pfunc1_max = ', nb_pfunc1_max
640    print*, 'nb_pfunc2_max = ', nb_pfunc2_max
641    print*, 'nb_pfunc3_max = ', nb_pfunc3_max
[2553]642    call abort
[2542]643 end if
644firstcall = .false.
645end if
[1796]646
647end subroutine reactionrates
648
649!======================================================================
650
651 subroutine fill_matrix(ilev, mat, prod, loss, c, nesp, nlayer, v_phot, v_3, v_4)
652
653!======================================================================
654! filling of the jacobian matrix
655!======================================================================
656
657use types_asis
[2542]658use chimiedata_h
[1796]659
660implicit none
661
662! input
663
664integer             :: ilev    ! level index
665integer             :: nesp    ! number of species in the chemistry
666integer, intent(in) :: nlayer  ! number of atmospheric layers
667
668real (kind = 8), dimension(nlayer,nesp)              :: c    ! number densities
669real (kind = 8), dimension(nlayer,      nb_phot_max) :: v_phot
670real (kind = 8), dimension(nlayer,nb_reaction_3_max) :: v_3
671real (kind = 8), dimension(nlayer,nb_reaction_4_max) :: v_4
672
673! output
674
675real (kind = 8), dimension(nesp,nesp), intent(out) :: mat  ! matrix
676real (kind = 8), dimension(nesp), intent(out)      :: prod, loss
677
678! local
679
680integer :: iesp
681integer :: ind_phot_2,ind_phot_4,ind_phot_6
682integer :: ind_3_2,ind_3_4,ind_3_6
683integer :: ind_4_2,ind_4_4,ind_4_6,ind_4_8
684integer :: iphot,i3,i4
685
686real(kind = jprb) :: eps, eps_4  ! implicit/explicit coefficient
687
688! initialisations
689
690mat(:,:) = 0.
691prod(:)  = 0.
692loss(:)  = 0.
693
694! photodissociations
695! or reactions a + c -> b + c
696! or reactions a + ice -> b + c
697
698do iphot = 1,nb_phot_max
699
700  ind_phot_2 = indice_phot(iphot)%z2
701  ind_phot_4 = indice_phot(iphot)%z4
702  ind_phot_6 = indice_phot(iphot)%z6
703
704  mat(ind_phot_2,ind_phot_2) = mat(ind_phot_2,ind_phot_2) + indice_phot(iphot)%z1*v_phot(ilev,iphot)
705  mat(ind_phot_4,ind_phot_2) = mat(ind_phot_4,ind_phot_2) - indice_phot(iphot)%z3*v_phot(ilev,iphot)
706  mat(ind_phot_6,ind_phot_2) = mat(ind_phot_6,ind_phot_2) - indice_phot(iphot)%z5*v_phot(ilev,iphot)
707
708  loss(ind_phot_2) = loss(ind_phot_2) + indice_phot(iphot)%z1*v_phot(ilev,iphot)
709  prod(ind_phot_4) = prod(ind_phot_4) + indice_phot(iphot)%z3*v_phot(ilev,iphot)*c(ilev,ind_phot_2)
710  prod(ind_phot_6) = prod(ind_phot_6) + indice_phot(iphot)%z5*v_phot(ilev,iphot)*c(ilev,ind_phot_2)
711
712end do
713
714! reactions a + a -> b + c
715
716do i3 = 1,nb_reaction_3_max
717
718  ind_3_2 = indice_3(i3)%z2
719  ind_3_4 = indice_3(i3)%z4
720  ind_3_6 = indice_3(i3)%z6
721
722  mat(ind_3_2,ind_3_2) = mat(ind_3_2,ind_3_2) + indice_3(i3)%z1*v_3(ilev,i3)*c(ilev,ind_3_2)
723  mat(ind_3_4,ind_3_2) = mat(ind_3_4,ind_3_2) - indice_3(i3)%z3*v_3(ilev,i3)*c(ilev,ind_3_2)
724  mat(ind_3_6,ind_3_2) = mat(ind_3_6,ind_3_2) - indice_3(i3)%z5*v_3(ilev,i3)*c(ilev,ind_3_2)
725
726  loss(ind_3_2) = loss(ind_3_2) + indice_3(i3)%z1*v_3(ilev,i3)*c(ilev,ind_3_2)
727  prod(ind_3_4) = prod(ind_3_4) + indice_3(i3)%z3*v_3(ilev,i3)*c(ilev,ind_3_2)*c(ilev,ind_3_2)
728  prod(ind_3_6) = prod(ind_3_6) + indice_3(i3)%z5*v_3(ilev,i3)*c(ilev,ind_3_2)*c(ilev,ind_3_2)
729
730end do
731
732! reactions a + b -> c + d
733
734eps = 1.d-10
735
736do i4 = 1,nb_reaction_4_max
737
738  ind_4_2 = indice_4(i4)%z2
739  ind_4_4 = indice_4(i4)%z4
740  ind_4_6 = indice_4(i4)%z6
741  ind_4_8 = indice_4(i4)%z8
742
743  eps_4 = abs(c(ilev,ind_4_2))/(abs(c(ilev,ind_4_2)) + abs(c(ilev,ind_4_4)) + eps)
744  eps_4 = min(eps_4,1.0_jprb)
745
746  mat(ind_4_2,ind_4_2) = mat(ind_4_2,ind_4_2) + indice_4(i4)%z1*v_4(ilev,i4)*(1. - eps_4)*c(ilev,ind_4_4)
747  mat(ind_4_2,ind_4_4) = mat(ind_4_2,ind_4_4) + indice_4(i4)%z1*v_4(ilev,i4)*eps_4*c(ilev,ind_4_2)
748  mat(ind_4_4,ind_4_2) = mat(ind_4_4,ind_4_2) + indice_4(i4)%z3*v_4(ilev,i4)*(1. - eps_4)*c(ilev,ind_4_4)
749  mat(ind_4_4,ind_4_4) = mat(ind_4_4,ind_4_4) + indice_4(i4)%z3*v_4(ilev,i4)*eps_4*c(ilev,ind_4_2)   
750  mat(ind_4_6,ind_4_2) = mat(ind_4_6,ind_4_2) - indice_4(i4)%z5*v_4(ilev,i4)*(1. - eps_4)*c(ilev,ind_4_4)
751  mat(ind_4_6,ind_4_4) = mat(ind_4_6,ind_4_4) - indice_4(i4)%z5*v_4(ilev,i4)*eps_4*c(ilev,ind_4_2)
752  mat(ind_4_8,ind_4_2) = mat(ind_4_8,ind_4_2) - indice_4(i4)%z7*v_4(ilev,i4)*(1. - eps_4)*c(ilev,ind_4_4)
753  mat(ind_4_8,ind_4_4) = mat(ind_4_8,ind_4_4) - indice_4(i4)%z7*v_4(ilev,i4)*eps_4*c(ilev,ind_4_2)
754
755  loss(ind_4_2) = loss(ind_4_2) + indice_4(i4)%z1*v_4(ilev,i4)*c(ilev,ind_4_4)
756  loss(ind_4_4) = loss(ind_4_4) + indice_4(i4)%z3*v_4(ilev,i4)*c(ilev,ind_4_2)
757  prod(ind_4_6) = prod(ind_4_6) + indice_4(i4)%z5*v_4(ilev,i4)*c(ilev,ind_4_2)*c(ilev,ind_4_4)
758  prod(ind_4_8) = prod(ind_4_8) + indice_4(i4)%z7*v_4(ilev,i4)*c(ilev,ind_4_2)*c(ilev,ind_4_4)
759
760end do
761
762end subroutine fill_matrix
763
764!================================================================
765
[2553]766 subroutine indice(nreact)
[1796]767
768!================================================================
769! set the "indice" arrays used to fill the jacobian matrix      !
770!----------------------------------------------------------------
771! reaction                                   type               !
772!----------------------------------------------------------------
773! A + hv   --> B + C     photolysis          indice_phot        !
774! A + B    --> C + D     bimolecular         indice_4           !
775! A + A    --> B + C     quadratic           indice_3           !
776! A + C    --> B + C     quenching           indice_phot        !
777! A + ice  --> B + C     heterogeneous       indice_phot        !
778!================================================================
779
780use types_asis
[2542]781use datafile_mod
782use ioipsl_getin_p_mod, only: getin_p
783use tracer_h, only: nesp
784use chimiedata_h
785use callkeys_mod, only: jonline
[1796]786
787implicit none
788
[2542]789! output
[1796]790
[2542]791integer, intent(out)              :: nreact          ! number of reactions in reactions files
[1796]792
793! local
794
795integer :: nb_phot, nb_reaction_3, nb_reaction_4
[2542]796integer :: nb_hv, nb_pfunc1, nb_pfunc2, nb_pfunc3
797integer :: iq, ireact
[1796]798
[2542]799character(len = 128)              :: reactfile       ! reactions table file name
800integer                           :: nbq             ! number of species in reactions file
[2553]801integer                           :: nlines          ! number of lines in reactions file
[2542]802integer                           :: pnreact         ! number of reaction in photochemical reactions file
803integer                           :: bnreact         ! number of reaction in bimolecular reactions file
804integer                           :: qnreact         ! number of reaction in quadratic reactions file
805integer                           :: specheck(nesp)  ! to count the species of traceur.def in reactions file
806integer                           :: specheckr(nesp) ! to count the reactant species of traceur.def in reactions file
807integer                           :: specheckp(nesp) ! to count the product species of traceur.def in reactions file
[1796]808
[2542]809nb_phot        = 0
810nb_reaction_3  = 0
811nb_reaction_4  = 0
812nb_phot_hv_max = 0
[1796]813
[2542]814nb_hv          = 0
815nb_pfunc1      = 0
816nb_pfunc2      = 0
817nb_pfunc3      = 0
[1796]818
819!===========================================================
[2542]820!  Read chemical reactions
[1796]821!===========================================================
822
[2542]823! Get number of reactions
[2553]824nlines         = 0
[2542]825nreact         = 0
826pnreact        = 0
827bnreact        = 0
828qnreact        = 0
[1796]829
[2553]830write(*,*) "Read reaction file"
831reactfile = "reactfile" ! default
832call getin_p("reactfile",reactfile) ! default path
833write(*,*) " reactfile = ",trim(reactfile)
[1796]834
[2553]835call count_react(reactfile,nlines,nreact,nb_phot,nb_reaction_4,nb_reaction_3,nb_hv,nb_pfunc1,nb_pfunc2,nb_pfunc3)
[1796]836
[2542]837!!!!!!!!!!! Hard coding reaction !!!!!!!!!!!!!!!!!!!!!!!!!!!
838nb_phot       = nb_phot       + nphot_hard_coding
839nb_reaction_4 = nb_reaction_4 + n4_hard_coding
840nb_reaction_3 = nb_reaction_3 + n3_hard_coding
841!!!!!!!!!!! END Hard coding reaction !!!!!!!!!!!!!!!!!!!!!!!
[1796]842
[2542]843write(*,*)'number of reaction in reaction files is = ',nreact
844print*, 'nb_phot       = ', nb_phot
845print*, 'nb_reaction_4 = ', nb_reaction_4
846print*, 'nb_reaction_3 = ', nb_reaction_3
847print*, '****************'
848print*, 'nb_hv         = ', nb_hv
849print*, 'nb_pfunc1     = ', nb_pfunc1
850print*, 'nb_pfunc2     = ', nb_pfunc2
851print*, 'nb_pfunc3     = ', nb_pfunc3
852nb_phot_max       = nb_phot
853nb_reaction_4_max = nb_reaction_4
854nb_reaction_3_max = nb_reaction_3
855nb_hv_max         = nb_hv
856nb_pfunc1_max     = nb_pfunc1
857nb_pfunc2_max     = nb_pfunc2
858nb_pfunc3_max     = nb_pfunc3
[1796]859
[2542]860! Allocate
861allocate(indice_phot(nb_phot_max))
862allocate(indice_4(nb_reaction_4_max))
863allocate(indice_3(nb_reaction_3_max))
[2553]864allocate(reactions(nreact))
[2542]865allocate(jlabel(nb_phot_hv_max,2))
[2553]866allocate(jparamline(nb_hv_max))
[2542]867allocate(pfunc1_param(nb_pfunc1_max))
868allocate(pfunc2_param(nb_pfunc2_max))
869allocate(pfunc3_param(nb_pfunc3_max))
[1796]870
[2542]871! Get reactants, products and number of species in reactfile
872! inititialize variables
873nbq             = 0
874specheck(:)     = 0
875specheckr(:)    = 0
876specheckp(:)    = 0
[2553]877reactions(:)    = reaction('',-1,0,.false.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.)
[2542]878pfunc1_param(:) = rtype1(0.,0.,0.,0.,0.)
879pfunc2_param(:) = rtype2(0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.)
880pfunc3_param(:) = rtype3(0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.,0.)
[2553]881nb_phot         = 0
882nb_reaction_4   = 0
883nb_reaction_3   = 0
[2542]884jlabel(:,:)     = ''
885jparamline(:)   = ''
[1796]886
[2553]887call get_react(reactfile,nlines,nreact,specheck,specheckr,specheckp,nbq,nb_phot,nb_reaction_4,nb_reaction_3)
[1796]888
[2542]889! rewrite jlabel corretly for output
890do ireact=1,nb_phot_hv_max
[2553]891  if (reactions(ireact)%three_prod) then
[2542]892    jlabel(ireact+1:nb_phot_hv_max,2) = jlabel(ireact:nb_phot_hv_max-1,2)
893    jlabel(ireact+1:nb_phot_hv_max,1) = jlabel(ireact:nb_phot_hv_max-1,1)
894    jlabel(ireact,1) = trim(jlabel(ireact,1))//'_a'
895    jlabel(ireact+1,1) = trim(jlabel(ireact+1,1))//'_b'
896  end if
897end do
[1796]898
[2542]899!!!!!!!!!!! Hard coding reaction !!!!!!!!!!!!!!!!!!!!!!!!!!!
900call indice_HC(nb_phot,nb_reaction_4,nb_reaction_3)
901!!!!!!!!!!! END Hard coding reaction !!!!!!!!!!!!!!!!!!!!!!!
[1796]902
[2542]903write(*,*)'number of species in reaction files is = ',nbq
904write(*,*)'species in reaction files are:'
[1796]905
[2542]906do iq=1,nesp
907  if (specheck(iq)==1) print*, chemnoms(iq)
908end do
[1796]909
910!===========================================================
[2542]911!  check species only destroy or product
[1796]912!===========================================================
913
[2542]914do iq=1,nesp
915  if (specheckr(iq)/=specheckp(iq)) then
916    if (specheckr(iq)==0 .and. specheckp(iq)==1) then
917      print*, 'WARNING: ', chemnoms(iq),' is only product'
918    else if (specheckr(iq)==1 .and. specheckp(iq)==0) then
919      print*, 'WARNING: ', chemnoms(iq),' is only destroy'
920    else
921      print*, 'Error in indice: bad value in specheckr or specheckp'
[2553]922      call abort
[2542]923    end if
924  end if
925end do
[1796]926
927!===========================================================
[2542]928!  check stochiometry
[1796]929!===========================================================
930
[2542]931! If you found a way
[1796]932
933!===========================================================
934!  check dimensions
935!===========================================================
936
[2542]937if (jonline) then
938  nd = nb_hv_max
939else if (nb_phot_hv_max /= 0) then
940  print*,'calchim: Read photolysis lookup table'
941  call read_phototable
942end if
[1796]943
944if ((nb_phot /= nb_phot_max)             .or.  &
945    (nb_reaction_3 /= nb_reaction_3_max) .or.  &
[2542]946    (nb_reaction_4 /= nb_reaction_4_max) .or.  &
947    (nd /= nb_hv_max)) then
948   print*, 'nb_phot       = ', nb_phot
949   print*, 'nb_reaction_4 = ', nb_reaction_4
950   print*, 'nb_reaction_3 = ', nb_reaction_3
951   print*, 'nd            = ', nd
[1796]952   print*, 'wrong dimensions in indice'
[2542]953   print*, 'nb_phot_max       = ', nb_phot_max
954   print*, 'nb_reaction_4_max = ', nb_reaction_4_max
955   print*, 'nb_reaction_3_max = ', nb_reaction_3_max
956   print*, 'nb_phot_hv_max    = ', nb_phot_hv_max
957   print*, 'nb_hv_max         = ', nb_hv_max
[2553]958   call abort
[1796]959end if 
960
961end subroutine indice
962
963!*****************************************************************
964
[2542]965      subroutine gcmtochim(nlayer, zycol, lswitch, nesp, dens, rm, c)
[1796]966
967!*****************************************************************
968
969      use callkeys_mod
970
971      implicit none
972
973
974!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
975!     input:
976!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
977     
978      integer, intent(in) :: nlayer ! number of atmospheric layers
[2542]979      integer, intent(in) :: nesp   ! number of species in the chemistry
[1796]980      integer :: lswitch            ! interface level between chemistries
981
[2542]982      real :: zycol(nlayer,nesp)    ! volume mixing ratios in the gcm
[1796]983      real :: dens(nlayer)          ! total number density (molecule.cm-3)
984
985!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
986!     output:
987!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
988
989      real, dimension(nlayer,nesp)            :: rm ! volume mixing ratios
990      real (kind = 8), dimension(nlayer,nesp) :: c  ! number densities (molecule.cm-3)
991     
992!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
993!     local:
994!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
995
996      integer      :: l, iesp
997     
[2542]998      rm(:,:) = 0.
[1796]999     
1000!ccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1001!     initialise mixing ratios
1002!ccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1003
1004      do l = 1,lswitch-1
[2542]1005         rm(l,:) = zycol(l,:)
[1796]1006      end do
1007
1008      where (rm(:,:) < 1.e-30)
1009         rm(:,:) = 0.
1010      end where
1011
1012!ccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1013!     initialise number densities
1014!ccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1015
1016      do iesp = 1,nesp
1017         do l = 1,lswitch-1
1018            c(l,iesp) = rm(l,iesp)*dens(l)
1019         end do
1020      end do
1021
1022      end subroutine gcmtochim
1023
1024!*****************************************************************
1025 
[2542]1026      subroutine chimtogcm(nlayer, zycol, lswitch, nesp, dens, c)
1027
[1796]1028 
1029!*****************************************************************
1030
1031      use callkeys_mod
1032
1033      implicit none
1034
1035
1036!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1037!     inputs:
1038!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1039 
1040      integer, intent(in) :: nlayer  ! number of atmospheric layers
[2542]1041      integer, intent(in) :: nesp    ! number of species in the chemistry
[1796]1042      integer :: lswitch             ! interface level between chemistries
1043
1044      real :: dens(nlayer)     ! total number density (molecule.cm-3)
1045      real (kind = 8), dimension(nlayer,nesp) :: c  ! number densities (molecule.cm-3)
1046
1047!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1048!     output:
1049!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1050       
[2542]1051      real zycol(nlayer,nesp)  ! volume mixing ratios in the gcm
[1796]1052
1053!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1054!     local:
1055!ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1056
1057      integer l
1058     
1059!ccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1060!     save mixing ratios for the gcm
1061!ccccccccccccccccccccccccccccccccccccccccccccccccccccccc
1062
1063      do l = 1,lswitch-1
[2542]1064         zycol(l,:)  = c(l,:)/dens(l)
[1796]1065      end do
1066
1067      end subroutine chimtogcm
1068
[2542]1069!*****************************************************************
[1796]1070
[2542]1071    subroutine split_str(line,words,n,nmax)
1072
1073!*****************************************************************
1074
1075        implicit none
1076        character(*), intent(in)  :: line
1077        integer,      intent(in)  :: nmax
1078        character(*), intent(out) :: words(nmax)
1079        integer,      intent(out) :: n          ! number of words at the end
1080        integer :: ios
1081        character(100) :: buf(100)  ! large buffer!
1082   
1083        n = 0
1084        do
1085            n = n + 1
[2553]1086            if (n>nmax) then
1087              print*,'Error in split_str: to much words'
1088              print*,'limit = ',nmax
1089              print*,'change it, if you want, with increasing nmax'
1090              print*,'line is:',line
1091              call abort
1092            end if
[2542]1093            read(line,*,iostat=ios) buf(1:n)  ! use list-directed input
1094            if (ios==0) then
1095                words(1:n) = buf(1:n)   ! if success, copy to the original array
1096            else
1097                n = n-1
1098                exit       ! if all the words are obtained, finish
1099            endif
1100        enddo
1101    end subroutine split_str
1102
1103!*****************************************************************
1104
[2553]1105    subroutine find_vtype(reactline,vtype)
[2542]1106
1107!*****************************************************************
1108
[2553]1109        use tracer_h,     only: nesp
1110        use chimiedata_h, only: indexchim
1111
1112        implicit none
1113
1114        character(len = 50), intent(in)    :: reactline ! all reactants of one reaction
1115        character(*),        intent(inout) :: vtype     ! "v3", "v4" or "vphot"
1116
1117        integer             :: nwr                      ! number of reactant for a reaction
1118        integer,parameter   :: nmax = 5                 ! number max of reactants or products
1119        character(len = 24) :: words(nmax)              ! to get words in reactants and products line
1120        integer             :: stochio(nesp)            ! stoichiometry of reaction
1121        integer             :: iword
1122
1123        ! init
1124        stochio(:) = 0
1125
1126        ! split reactant
1127        call split_str(reactline,words,nwr,nmax)
1128
1129        ! set stochio
1130        do iword = 1,nwr
1131            if (trim(words(iword))=="M") exit
1132            if (trim(words(iword))/="hv"         &
1133                .and. trim(words(iword))/="dummy") stochio(indexchim(words(iword))) = stochio(indexchim(words(iword))) + 1
1134        end do
1135
1136        ! set vtype
1137        if (sum(stochio)==1) then
1138            vtype = "vphot"
1139        else if (sum(stochio)==2) then
1140            if (any(stochio==2)) then
1141                vtype = "v3"
1142            else
1143                vtype = "v4"
1144            end if
1145        else if (sum(stochio)==3) then
1146            if (any(stochio==2)) then
1147                vtype = "v4"
1148            else
1149                print*,'Error in photochemistry_asis (find_vtype):'
1150                print*,'3 different reactants not implemented'
1151                call abort
1152            end if
1153        else
1154            print*,'Error in photochemistry_asis (find_vtype):'
1155            print*,'more than 2 different reactants not implemented'
1156            call abort
1157        end if
1158
1159    end subroutine find_vtype
1160
1161!*****************************************************************
1162
1163    subroutine count_react(reactfile,nlines,nreact,nb_phot,nb_reaction_4,nb_reaction_3,nb_hv,nb_pfunc1,nb_pfunc2,nb_pfunc3)
1164
1165!*****************************************************************
1166
[2542]1167        use types_asis, only : nb_phot_hv_max
1168
1169        implicit none
[2553]1170        character(*), intent(in)     :: reactfile     ! name of the file to read
1171        integer,      intent(inout)  :: nlines        ! number of lines in the file
1172        integer,      intent(out)    :: nreact        ! real number of reaction
1173        integer,      intent(inout)  :: nb_phot       ! dimension of "vphot" reaction
1174        integer,      intent(inout)  :: nb_reaction_4 ! dimension of "v4" reaction
1175        integer,      intent(inout)  :: nb_reaction_3 ! dimension of "v3" reaction
1176        integer,      intent(inout)  :: nb_hv         ! number of typerate 0 reaction
1177        integer,      intent(inout)  :: nb_pfunc1     ! number of typerate 1 reaction
1178        integer,      intent(inout)  :: nb_pfunc2     ! number of typerate 2 reaction
1179        integer,      intent(inout)  :: nb_pfunc3     ! number of typerate 3 reaction
[2542]1180
1181        ! local
[2553]1182        character(len = 50) :: reactline              ! all reactants of one reaction
1183        character(len = 50) :: prodline               ! all produts of one reaction
1184        integer             :: typerate               ! get the type of the rate reaction coefficient (pfunc_i)
1185        character(5)        :: vtype                  ! "v3", "v4" or "vphot"
1186        integer             :: nwp                    ! number of products for a reaction
1187        integer,parameter   :: nmax = 5               ! number max of reactants or products
1188        character(len = 24) :: words(nmax)            ! to get words in reactants and products line
[2542]1189        integer             :: ierr
1190
[2553]1191        nreact = 0
1192        vtype  = ''
[2542]1193
1194        open(402, form = 'formatted', status = 'old',                &
1195              file ='chemnetwork/'//trim(reactfile),iostat=ierr)
1196
1197        if (ierr /= 0) THEN
1198           write(*,*)'Error : cannot open chemical reaction file : chemnetwork/'//trim(reactfile)
1199           write(*,*)'It should be in your simulation directory in chemnetwork directory'
1200           write(*,*)'   You can change the input chemical reactions file name in'
1201           write(*,*)'   callphys.def with:'
1202           write(*,*)'   monoreact=filename or bimolreact=filename or quadrareact=filename'
1203           write(*,*)'   depending on what chemical reaction type it is'
[2553]1204           call abort
[2542]1205        end if
1206   
1207        do
1208          read(402,'(A,A,I2)',iostat=ierr) reactline, prodline, typerate
1209          if (ierr<0) exit
[2553]1210          ! count the number of lines
[2542]1211          nlines = nlines + 1
1212          if (reactline(1:1)/='!' .and. reactline(1:1)/='') then
1213            ! count the number of reaction
1214            nreact = nreact + 1
[2553]1215
1216            call find_vtype(reactline,vtype)
[2542]1217            call split_str(prodline,words,nwp,nmax)
1218
[2553]1219            ! count the dimension of each rate reaction coefficient type
1220            if (trim(vtype)=="vphot") then
1221                nb_phot = nb_phot + 1
1222                ! check three product reaction
1223                if (nwp>2 .and. trim(words(1))/=trim(words(2)) &
1224                          .and. trim(words(1))/=trim(words(3)) &
1225                          .and. trim(words(2))/=trim(words(3))) nb_phot = nb_phot + 1
1226            else if (trim(vtype)=="v4") then
1227                nb_reaction_4 = nb_reaction_4 + 1
1228                ! check three product reaction
1229                if (nwp>2 .and. trim(words(1))/=trim(words(2)) &
1230                          .and. trim(words(1))/=trim(words(3)) &
1231                          .and. trim(words(2))/=trim(words(3))) nb_reaction_4 = nb_reaction_4 + 1
1232            else if (trim(vtype)=="v3") then
1233                nb_reaction_3 = nb_reaction_3 + 1
1234                ! check three product reaction
1235                if (nwp>2 .and. trim(words(1))/=trim(words(2)) &
1236                          .and. trim(words(1))/=trim(words(3)) &
1237                          .and. trim(words(2))/=trim(words(3))) nb_reaction_3 = nb_reaction_3 + 1
1238            else
1239                print*,'Error in photochemistry_asis (count_react):'
1240                print*,'vtype not found'
1241                call abort
1242            end if
1243
[2542]1244            ! count the number of each rate reaction coefficient type
1245            if (typerate==0) then
1246              nb_hv = nb_hv + 1
1247              nb_phot_hv_max = nb_phot_hv_max + 1
1248              if (nwp>2 .and. trim(words(1))/=trim(words(2)) &
1249                        .and. trim(words(1))/=trim(words(3)) &
1250                        .and. trim(words(2))/=trim(words(3))) nb_phot_hv_max = nb_phot_hv_max + 1
1251            else if (typerate==1) then
1252              nb_pfunc1 = nb_pfunc1 + 1
1253            else if (typerate==2) then
1254              nb_pfunc2 = nb_pfunc2 + 1
1255            else if (typerate==3) then
1256              nb_pfunc3 = nb_pfunc3 + 1
1257            else
1258              print*, 'Error in indice: wrong index coefficient rate line ',nlines
1259              print*, 'in file : chemnetwork/'//trim(reactfile)
1260              print*, 'It should be 0 for photolysis reations and 1 or 2 for the others'
1261              print*, 'And not : ', typerate
[2553]1262              call abort
[2542]1263            end if
1264
1265          end if
1266
1267        end do
1268
1269        close(402)
1270
1271    end subroutine count_react
1272
1273!*****************************************************************
1274
[2553]1275    subroutine get_react(reactfile,nlines,nreact,specheck,specheckr,specheckp, &
1276                         nbq,nb_phot,nb_reaction_4,nb_reaction_3)
[2542]1277
1278!*****************************************************************
1279
1280        use types_asis
1281        use tracer_h
1282        use chimiedata_h, only: indexchim
1283        use callkeys_mod, only: jonline
1284
1285        implicit none
1286        character(*), intent(in)     :: reactfile          ! name of the file to read
1287        integer,      intent(in)     :: nlines             ! number of lines in the file
1288        integer,      intent(in)     :: nreact             ! real number of reaction in the file
[2553]1289        integer,      intent(out)    :: nb_phot            ! number of "vphot" calculation reactions
1290        integer,      intent(out)    :: nb_reaction_4      ! number of "vphot" calculation reactions
1291        integer,      intent(out)    :: nb_reaction_3      ! number of "vphot" calculation reactions
[2542]1292        integer,      intent(inout)  :: specheck(nesp)     ! to count the species of traceur.def in reactions file
1293        integer,      intent(inout)  :: specheckr(nesp)    ! to count the reactant species of traceur.def in reactions file
1294        integer,      intent(inout)  :: specheckp(nesp)    ! to count the product species of traceur.def in reactions file
1295        integer,      intent(inout)  :: nbq                ! number of species in reactions file
1296
1297        ! local
1298        character(len = 50)  :: reactline                  ! all reactants of one reaction
1299        character(len = 50)  :: prodline                   ! all produts of one reaction
1300        integer              :: nwr                        ! number of reactants for a reaction
1301        integer              :: nwp                        ! number of products for a reaction
1302        integer,parameter    :: nmax = 5                   ! number max of reactants or products
1303        character(len = 24)  :: words(nmax)                ! to get words in reactants and products line
1304        real                 :: nindice(2*nmax)            ! stoichiometry of species (for indice variables)
1305        integer              :: iindice(2*nmax)            ! indice of species (for indice variables)
1306        character(len = 500) :: paramline                  ! line of reactions parameters
[2553]1307        integer              :: stochio(nesp)              ! stoichiometry of reaction
1308        integer              :: ierr, ilines, ireact, i_dummy, iw, ispe, iloc
1309        integer              :: nb_phot_hv, nb_hv, nb_pfunc1, nb_pfunc2, nb_pfunc3
[2542]1310
[2553]1311        i_dummy       = 1
1312        ireact        = 0
1313        nb_phot       = 0
1314        nb_phot_hv    = 0
1315        nb_hv         = 0
1316        nb_pfunc1     = 0
1317        nb_pfunc2     = 0
1318        nb_pfunc3     = 0
[2542]1319
1320        open(402, form = 'formatted', status = 'old',                &
1321              file ='chemnetwork/'//trim(reactfile),iostat=ierr)
1322
1323        if (ierr /= 0) THEN
1324           write(*,*)'Error : cannot open chemical reaction file : chemnetwork/'//trim(reactfile)
1325           write(*,*)'It should be in your simulation directory in chemnetwork directory'
1326           write(*,*)'   You can change the input chemical reactions file name in'
1327           write(*,*)'   callphys.def with:'
1328           write(*,*)'   monoreact=filename or bimolreact=filename or quadrareact=filename'
1329           write(*,*)'   depending on what chemical reaction type it is'
[2553]1330           call abort
[2542]1331        end if
1332
1333        do ilines=1,nlines
1334          paramline = ''
1335
1336          read(402,'(A,A,A)') reactline, prodline, paramline
1337
1338          ! continue only if it's not a comment line
1339          if (reactline(1:1)/='!' .and. reactline(1:1)/='') then
1340
[2553]1341            ! increment number of reactions
[2542]1342            ireact = ireact + 1
[2553]1343
1344            ! fill reaction vtype
1345            call find_vtype(reactline,reactions(ireact)%vtype)
1346            if (trim(reactions(ireact)%vtype)=="v4") then
1347                nb_reaction_4 = nb_reaction_4 + 1
1348            else if (trim(reactions(ireact)%vtype)=="v3") then
1349                nb_reaction_3 = nb_reaction_3 + 1
1350            else if (trim(reactions(ireact)%vtype)=="vphot") then
1351                nb_phot = nb_phot + 1
1352            else
1353                print*,'Error in photochemistry_asis (get_react):'
1354                print*,'vtype not found'
1355                call abort
1356            end if
1357
1358            ! fill reaction rate type and parameters
[2542]1359            if (trim(paramline)=='') then
[2553]1360                print*, 'Error in reactfile: where are the parameters - line',ilines
1361                call abort
[2542]1362            else
[2553]1363                read(paramline,*) reactions(ireact)%rtype
1364                if (reactions(ireact)%rtype==1) then
1365                  nb_pfunc1 = nb_pfunc1 + 1
1366                  read(paramline,*) reactions(ireact)%rtype, pfunc1_param(nb_pfunc1)
1367                else if (reactions(ireact)%rtype==0) then
1368                  nb_hv = nb_hv + 1
1369                  nb_phot_hv = nb_phot_hv + 1
1370                  if (jonline) then
1371                    read(paramline,'(I5,A,A)') reactions(ireact)%rtype, jlabel(nb_hv,1), jparamline(nb_hv)
1372                  else
1373                    read(paramline,*) reactions(ireact)%rtype, jlabel(nb_hv,1)
1374                  end if
1375                else if (reactions(ireact)%rtype==2) then
1376                  nb_pfunc2 = nb_pfunc2 + 1
1377                  read(paramline,*) reactions(ireact)%rtype, pfunc2_param(nb_pfunc2)
1378                else if (reactions(ireact)%rtype==3) then
1379                  nb_pfunc3 = nb_pfunc3 + 1
1380                  read(paramline,*) reactions(ireact)%rtype, pfunc3_param(nb_pfunc3)
[2542]1381                end if
1382            end if
[2553]1383
1384            ! WARNING: the implementation is limited to 3 different reactants (for now only 2) and 3 different products
1385            nindice(:) = 0.0     ! 3 first indice for reactants, 3 following for products
1386            iindice(:) = i_dummy ! 3 first indice for reactants, 3 following for products
1387
1388            !-----------------!
1389            !--- reactants ---!
1390            !-----------------!
1391
1392            ! init for reactant
1393            stochio(:) = 0
1394            ! split reactant
[2542]1395            call split_str(reactline,words,nwr,nmax)
[2553]1396            ! set species that are photolysed
1397            if (reactions(ireact)%rtype==0) jlabel(nb_hv,2) = words(1)
1398            ! find reactant stochio
1399            do iw = 1,nwr
1400                ! fill third body index
1401                if (trim(words(iw))=="M") then
1402                    if (iw==nwr) then
1403                        exit
1404                    else if (iw==nwr-1) then
1405                        reactions(ireact)%third_body = indexchim(words(iw+1))
1406                        exit
1407                    else
1408                        print*, 'Error in reactfile: just only one specie can be after M corresponding to the third body - line',ilines
1409                        call abort
1410                    end if
[2542]1411                end if
[2553]1412                ! count stochio
1413                if (trim(words(iw))/="hv"         &
1414                    .and. trim(words(iw))/="dummy") stochio(indexchim(words(iw))) = stochio(indexchim(words(iw))) + 1
1415            end do
1416            ! get reaction reactant stochio and indice
1417            iloc = 0
1418            do ispe = 1,nesp
1419                if (stochio(ispe)==0) cycle
1420                iloc = iloc + 1
1421                nindice(iloc) = stochio(ispe)
1422                iindice(iloc) = ispe
1423                ! check up: to count the species used in 'reactfile'
1424                if (specheck(ispe)==0) then
1425                    specheckr(ispe) = 1
1426                    specheck(ispe) = 1
1427                    nbq = nbq + 1
1428                else if (specheckr(ispe)==0) then
1429                    specheckr(ispe) = 1
[2542]1430                end if
1431            end do
[2553]1432            ! fill reaction reactant stochio and indice
1433            reactions(ireact)%ir1 = nindice(1)
1434            reactions(ireact)%r1  = iindice(1)
1435            reactions(ireact)%ir2 = nindice(2)
1436            reactions(ireact)%r2  = iindice(2)
1437            reactions(ireact)%ir3 = nindice(3)
1438            reactions(ireact)%r3  = iindice(3)
[2542]1439
[2553]1440            !----------------!
1441            !--- products ---!
1442            !----------------!
1443
1444            ! init for products
1445            stochio(:) = 0
1446            ! split products
[2542]1447            call split_str(prodline,words,nwp,nmax)
[2553]1448            ! find products stochio
1449            do iw = 1,nwp
1450                stochio(indexchim(words(iw))) = stochio(indexchim(words(iw))) + 1
1451            end do
1452            ! get reaction product stochio and indice
1453            iloc = 3
1454            do ispe = 1,nesp
1455                if (stochio(ispe)==0) cycle
1456                iloc = iloc + 1
1457                nindice(iloc) = stochio(ispe)
1458                iindice(iloc) = ispe
1459                ! check up: to count the species used in 'reactfile'
1460                if (specheck(ispe)==0) then
1461                    specheckp(ispe) = 1
1462                    specheck(ispe) = 1
1463                    nbq = nbq + 1
1464                else if (specheckp(ispe)==0) then
1465                    specheckp(ispe) = 1
[2542]1466                end if
1467            end do
[2553]1468            ! fill reaction product stochio and indice
1469            reactions(ireact)%ip1 = nindice(4)
1470            reactions(ireact)%p1  = iindice(4)
1471            reactions(ireact)%ip2 = nindice(5)
1472            reactions(ireact)%p2  = iindice(5)
1473            reactions(ireact)%ip3 = nindice(6)
1474            reactions(ireact)%p3  = iindice(6)
1475            ! set reaction three prod to true with checking in position 6 if there is three different products
1476            if (nindice(6)/=0) reactions(ireact)%three_prod = .true.
[2542]1477
[2553]1478
1479            !-------------------------!
1480            !--- fill indice array ---!
1481            !-------------------------!
1482
1483            if (trim(reactions(ireact)%vtype)=="v4") then
1484                if (nindice(6)==0) then ! reaction with 1 or 2 products
1485                    ! z4spec(ir1,r1,ir2,r2,ip1,p1,ip2,p2)
1486                    indice_4(nb_reaction_4) = z4spec(nindice(1), iindice(1), nindice(2), iindice(2), nindice(4), iindice(4), nindice(5), iindice(5))
[2542]1487                else ! reaction with 3 different products
[2553]1488                    indice_4(nb_reaction_4) = z4spec(nindice(1)/2., iindice(1), nindice(2)/2., iindice(2), nindice(4), iindice(4), nindice(5)/2., iindice(5))
1489                    nb_reaction_4 = nb_reaction_4 + 1
1490                    indice_4(nb_reaction_4) = z4spec(nindice(1)/2., iindice(1), nindice(2)/2., iindice(2), nindice(6), iindice(6), nindice(5)/2., iindice(5))
[2542]1491                end if
[2553]1492            else if (trim(reactions(ireact)%vtype)=="v3") then
1493                if (nindice(6)==0) then ! reaction with 1 or 2 products
1494                    ! z3spec(ir1,r1,ip1,p1,ip2,p2)
1495                    indice_3(nb_reaction_3) = z3spec(nindice(1), iindice(1), nindice(4), iindice(4), nindice(5), iindice(5))
[2542]1496                else ! reaction with 3 different products
[2553]1497                    indice_3(nb_reaction_3) = z3spec(nindice(1)/2., iindice(1), nindice(4), iindice(4), 0.0, i_dummy)
1498                    nb_reaction_3 = nb_reaction_3 + 1
1499                    indice_3(nb_reaction_3) = z3spec(nindice(1)/2., iindice(1), nindice(5), iindice(5), nindice(6), iindice(6))
[2542]1500                end if
[2553]1501            else if (trim(reactions(ireact)%vtype)=="vphot") then
1502                if (reactions(ireact)%rtype==0) then
1503                    if (nindice(6)==0) then ! reaction with 1 or 2 products
1504                        ! z3spec(ir1,r1,ip1,p1,ip2,p2)
1505                        indice_phot(nb_phot_hv) = z3spec(nindice(1), iindice(1), nindice(4), iindice(4), nindice(5), iindice(5))
1506                    else ! reaction with 3 different products
1507                        indice_phot(nb_phot_hv) = z3spec(nindice(1)/2., iindice(1), nindice(4), iindice(4), 0.0, i_dummy)
1508                        nb_phot = nb_phot + 1
1509                        nb_phot_hv = nb_phot_hv + 1
1510                        indice_phot(nb_phot_hv) = z3spec(nindice(1)/2., iindice(1), nindice(5), iindice(5), nindice(6), iindice(6))
1511                    end if
1512                else
1513                    if (nindice(6)==0) then ! reaction with 1 or 2 products
1514                        ! z3spec(ir1,r1,ip1,p1,ip2,p2)
1515                        indice_phot(nb_phot_hv_max+nb_phot-nb_phot_hv) = z3spec(nindice(1), iindice(1), nindice(4), iindice(4), nindice(5), iindice(5))
1516                    else ! reaction with 3 different products
1517                        indice_phot(nb_phot_hv_max+nb_phot-nb_phot_hv) = z3spec(nindice(1)/2., iindice(1), nindice(4), iindice(4), 0.0, i_dummy)
1518                        nb_phot = nb_phot + 1
1519                        indice_phot(nb_phot_hv_max+nb_phot-nb_phot_hv) = z3spec(nindice(1)/2., iindice(1), nindice(5), iindice(5), nindice(6), iindice(6))
1520                    end if
[2542]1521                end if
[2553]1522            else
1523                print*,'Error in photochemistry_asis (get_react):'
1524                print*,'vtype',reactions(ireact)%vtype,' not implemented'
1525                call abort
[2542]1526            end if
1527       
[2553]1528          end if ! end if comment line
[2542]1529
[2553]1530        end do ! end loop on lines
[2542]1531
1532        close(402)
1533
1534    end subroutine get_react
1535
1536end subroutine photochemistry_asis
Note: See TracBrowser for help on using the repository browser.