module tracer_mod

 implicit none
 
      ! number of tracers:
      integer,save :: nqmx ! initialized in ini_tracer_mod

!$OMP THREADPRIVATE(nqmx)  
   
      character*30,allocatable,save ::  noms(:)  ! name of the tracer
      real,allocatable,save :: mmol(:)           ! mole mass of tracer (g/mol-1) 
      real,allocatable,save :: radius(:)   ! dust and ice particle radius (m)
      real,allocatable,save :: rho_q(:)    ! tracer densities (kg.m-3)
      real,allocatable,save :: alpha_lift(:) ! saltation vertical flux/horiz flux ratio (m-1)
      real,allocatable,save :: alpha_devil(:) ! lifting coeeficient by dust devil

!$OMP THREADPRIVATE(noms,mmol,radius,rho_q,alpha_lift,                           &
!$OMP                alpha_devil)  

      real,save :: varian      ! Characteristic variance of log-normal distribution
      real,save :: r3n_q     ! used to compute r0 from number and mass mixing ratio
      real,save :: rho_dust     ! Mars dust density (kg.m-3)
      real,save :: rho_ice     ! Water ice density (kg.m-3)
      real,save :: nuice_ref   ! Effective variance of the water ice dist.
      real,save :: nuice_sed   ! Sedimentation effective variance of the water ice dist.
      real,save :: ref_r0        ! for computing reff=ref_r0*r0 (in log.n. distribution)
      real,save :: rho_ice_co2     ! co2 ice density (kg.m-3)
      real,save :: nuiceco2_sed   ! Sedimentation effective variance of the co2 ice dist.
      real,save :: nuiceco2_ref   ! Effective variance of the co2 ice dist.

!$OMP THREADPRIVATE(varian,r3n_q,rho_dust,rho_ice,nuice_ref,                     &
!$OMP                nuice_sed,ref_r0,rho_ice_co2,nuiceco2_sed,nuiceco2_ref)  
      
      real,save :: ccn_factor  ! ratio of nuclei for water ice particles

!$OMP THREADPRIVATE(ccn_factor)  

      INTEGER,ALLOCATABLE,SAVE :: nqdust(:) ! to store the indexes of dust tracers (cf aeropacity)

!$OMP THREADPRIVATE(nqdust)  


! tracer indexes: these are initialized in initracer and should be 0 if the
!                 corresponding tracer does not exist
      ! dust
      integer,allocatable,save :: igcm_dustbin(:) ! for dustbin 'dust' tracers
      ! dust, special doubleq case
      integer,save :: igcm_dust_mass   ! dust mass mixing ratio
                                  !   (for transported dust)
      integer,save :: igcm_dust_number ! dust number mixing ratio
                                  !   (transported dust)
      integer,save :: igcm_ccn_mass   ! CCN mass mixing ratio
      integer,save :: igcm_ccn_number ! CCN number mixing ratio
      integer,save :: igcm_dust_submicron ! submicron dust mixing ratio
      integer,save :: igcm_stormdust_mass   !  storm dust mass mixing ratio
      integer,save :: igcm_stormdust_number !  storm dust number mixing ratio
      integer,save :: igcm_topdust_mass   !  topdust mass mixing ratio
      integer,save :: igcm_topdust_number !  topdust number mixing ratio

!$OMP THREADPRIVATE(igcm_dustbin,igcm_dust_mass,igcm_dust_number,igcm_ccn_mass,  &
!$OMP                igcm_ccn_number,igcm_dust_submicron,igcm_stormdust_mass,    &
!$OMP                igcm_stormdust_number,igcm_topdust_mass,igcm_topdust_number)  

      integer,save :: igcm_ccnco2_mass   ! CCN (dust and/or water ice) for CO2 mass mixing ratio
      integer,save :: igcm_ccnco2_number ! CCN (dust and/or water ice) for CO2 number mixing ratio
      integer,save :: igcm_ccnco2_meteor_mass   ! CCN (dust and/or water ice) for CO2 mass mixing ratio
      integer,save :: igcm_ccnco2_meteor_number ! CCN (dust and/or water ice) for CO2 number mixing ratio
      integer,save :: igcm_ccnco2_h2o_mass_ice   ! CCN (dust and/or water ice) for CO2 mass mixing ratio
      integer,save :: igcm_ccnco2_h2o_mass_ccn   ! CCN (dust and/or water ice) for CO2 mass mixing ratio
      integer,save :: igcm_ccnco2_h2o_number ! CCN (dust and/or water ice) for CO2 number mixing ratio

!$OMP THREADPRIVATE(igcm_ccnco2_mass,igcm_ccnco2_number,                         &
!$OMP                igcm_ccnco2_h2o_mass_ice,igcm_ccnco2_h2o_mass_ccn,          &
!$OMP                igcm_ccnco2_h2o_number)  

      ! water
      integer,save :: igcm_h2o_vap ! water vapour
      integer,save :: igcm_h2o_ice ! water ice
      integer,save :: igcm_hdo_vap ! hdo vapour
      integer,save :: igcm_hdo_ice ! hdo ice
      integer,save :: igcm_co2_ice ! co2 ice

!$OMP THREADPRIVATE(igcm_h2o_vap, igcm_h2o_ice, igcm_hdo_vap, igcm_hdo_ice,      &
!$OMP                igcm_co2_ice)  

      ! chemistry:
      integer,save :: igcm_co2
      integer,save :: igcm_co
      integer,save :: igcm_o
      integer,save :: igcm_o1d
      integer,save :: igcm_o2
      integer,save :: igcm_o3
      integer,save :: igcm_h
      integer,save :: igcm_h2
      integer,save :: igcm_oh
      integer,save :: igcm_ho2
      integer,save :: igcm_h2o2
      integer,save :: igcm_n2
      integer,save :: igcm_ar
      integer,save :: igcm_n
      integer,save :: igcm_no
      integer,save :: igcm_no2
      integer,save :: igcm_n2d
      integer,save :: igcm_he
      integer,save :: igcm_ch4

!$OMP THREADPRIVATE(igcm_co2,igcm_co,igcm_o,igcm_o1d,igcm_o2,igcm_o3,igcm_h,   &
!$OMP                igcm_h2,igcm_oh,igcm_ho2,igcm_h2o2,igcm_n2,igcm_ar,igcm_n,&
!$OMP               igcm_no,igcm_no2,igcm_n2d,igcm_he,igcm_ch4)

      !Deuterated species derived from HDO
      integer,save :: igcm_od
      integer,save :: igcm_d
      integer,save :: igcm_hd
      integer,save :: igcm_do2
      integer,save :: igcm_hdo2

!$OMP THREADPRIVATE(igcm_od,igcm_d,igcm_hd, igcm_do2,igcm_hdo2)

      ! Ions
      integer,save :: igcm_co2plus
      integer,save :: igcm_oplus
      integer,save :: igcm_o2plus
      integer,save :: igcm_coplus
      integer,save :: igcm_cplus
      integer,save :: igcm_nplus
      integer,save :: igcm_noplus
      integer,save :: igcm_n2plus 
      integer,save :: igcm_hplus
      integer,save :: igcm_hco2plus
      integer,save :: igcm_hcoplus
      integer,save :: igcm_h2oplus
      integer,save :: igcm_h3oplus
      integer,save :: igcm_ohplus
      integer,save :: igcm_elec

!$OMP THREADPRIVATE(igcm_co2plus,igcm_oplus,igcm_o2plus,igcm_coplus,igcm_cplus,   &
!$OMP                igcm_nplus,igcm_noplus,igcm_n2plus,igcm_hplus,igcm_hco2plus,&
!$OMP                igcm_hcoplus,igcm_h2oplus,igcm_h3oplus,igcm_ohplus,igcm_elec) 

      ! other tracers
      integer,save :: igcm_ar_n2 ! for simulations using co2 +neutral gas
!$OMP THREADPRIVATE(igcm_ar_n2)

      ! Isotopes
      integer, save  :: nqparents ! # of tracers defined as parents (i.e. with or without children)
      integer, allocatable, save :: nqchildren(:) ! # of children of the considered tracer
!$OMP THREADPRIVATE(nqparents,nqchildren)  

      real, parameter :: qparentmin=1.e-16 ! threshold for the "parent" mixing ratio qparent to calculate Ratio=qchild/qparent
      real, parameter :: masseqmin=1.e-16 ! threschold for the "parent" transporting masse martian case as there are no granchildren

!-----------------------------------------------------------------------

  contains
  
    subroutine ini_tracer_mod
      
      use mod_phys_lmdz_para, only : is_master, bcast
      ! utilities to parse "old school" traceur.def file
      use parse_traceur_file_mod, only: get_nq_from_traceur_file
      use parse_traceur_file_mod, only: get_names_from_traceur_file
      ! utilities to parse "new" tracer.def file
      use parse_tracer_file_mod, only: get_nq_from_tracer_file
      use parse_tracer_file_mod, only: get_names_from_tracer_file
      use parse_tracer_file_mod, only: get_children_from_tracer_file
      implicit none
      
      integer :: iq, count
      character(len=20) :: txt ! to store some text

      logical :: traceur_file_exists
      logical :: tracer_file_exists
      logical :: co2_tracer_found
      
      ! look for traceur.def file
      if (is_master) inquire(file="traceur.def",exist=traceur_file_exists)
      call bcast(traceur_file_exists)
      
      if (traceur_file_exists) then
        ! parse the traceur.def file
        call get_nq_from_traceur_file(nqmx)
        allocate(noms(nqmx))
        allocate(nqchildren(nqmx))
        ! get values for noms,nqparents,nqchildren :
        call get_names_from_traceur_file(nqmx,noms,nqparents,nqchildren)
      else ! no traceur.def file
        if (is_master) then
          write(*,*)" ini_tracer_mod: no traceur.def file! " // &
                    "Look for a tracer.def file"
          ! look for a tracer.def file
          inquire(file="tracer.def",exist=tracer_file_exists)
        endif ! of if(is_master)
        call bcast(tracer_file_exists)
        
        if (tracer_file_exists) then
          ! parse the tracer.def file
          call get_nq_from_tracer_file(nqmx)
          allocate(noms(nqmx))
          ! get values for noms,nqparents,nqchildren :
          call get_names_from_tracer_file(nqmx,noms)
          allocate(nqchildren(nqmx))
          ! get values for nqparents and nqchildren
          call get_children_from_tracer_file(nqmx,noms,nqparents,nqchildren)
        else
          call abort_physic("ini_tracer_mod","no tracer.def file!",1)
        endif ! of if (tracer_file_exists)
      endif ! of if (traceur_file_exists)

      ! check that there is a "co2" tracer present
      co2_tracer_found=.false.
      do iq=1,nqmx
        if(noms(iq).eq."co2") then
          co2_tracer_found=.true.
          exit
        endif
      enddo

      if(.not.co2_tracer_found) then
         call abort_physic("ini_tracer_mod","co2 tracer is now mandatory",1)
      endif
      
      ! allocate module arrays:
      ! -- not domain-dependent
      allocate(mmol(nqmx))
      allocate(radius(nqmx))
      allocate(rho_q(nqmx))
      allocate(alpha_lift(nqmx))
      allocate(alpha_devil(nqmx))
      allocate(igcm_dustbin(nqmx))
      allocate(nqdust(nqmx))
      
    end subroutine ini_tracer_mod

    subroutine end_tracer_mod

    implicit none

      if (allocated(noms)) deallocate(noms)
      if (allocated(mmol)) deallocate(mmol)
      if (allocated(radius)) deallocate(radius)
      if (allocated(rho_q)) deallocate(rho_q)
      if (allocated(alpha_lift)) deallocate(alpha_lift)
      if (allocated(alpha_devil)) deallocate(alpha_devil)
      if (allocated(igcm_dustbin)) deallocate(igcm_dustbin)
      if (allocated(nqdust)) deallocate(nqdust)

    end subroutine end_tracer_mod

end module tracer_mod