source: CONFIG/publications/ICOLMDZORINCA_CO2_Transport_GMD_2023/INCA/src/INCA_SRC/conf_chem.F90 @ 6610

!$Id
!! =========================================================================
!! INCA - INteraction with Chemistry and Aerosols
!! 
!! Copyright Laboratoire des Sciences du Climat et de l'Environnement (LSCE)
!!           Unite mixte CEA-CNRS-UVSQ
!! 
!! Contributors to this INCA subroutine:
!! 
!! Anne Cozic, LSCE, anne.cozic@cea.fr
!!
!! This software is a computer program whose purpose is to simulate the 
!! atmospheric gas phase and aerosol composition. The model is designed to be
!! used within a transport model or a general circulation model. This version 
!! of INCA was designed to be coupled to the LMDz GCM. LMDz-INCA accounts
!! for emissions, transport (resolved and sub-grid scale), photochemical 
!! transformations, and scavenging (dry deposition and washout) of chemical 
!! species and aerosols interactively in the GCM. Several versions of the INCA
!! model are currently used depending on the envisaged applications with the 
!! chemistry-climate model. 
!! 
!! This software is governed by the CeCILL  license under French law and
!! abiding by the rules of distribution of free software.  You can  use, 
!! modify and/ or redistribute the software under the terms of the CeCILL
!! license as circulated by CEA, CNRS and INRIA at the following URL
!! "http://www.cecill.info". 
!! 
!! As a counterpart to the access to the source code and  rights to copy,
!! modify and redistribute granted by the license, users are provided only
!! with a limited warranty  and the software's author,  the holder of the
!! economic rights,  and the successive licensors  have only  limited
!! liability. 
!! 
!! In this respect, the user's attention is drawn to the risks associated
!! with loading,  using,  modifying and/or developing or reproducing the
!! software by the user in light of its specific status of free software,
!! that may mean  that it is complicated to manipulate,  and  that  also
!! therefore means  that it is reserved for developers  and  experienced
!! professionals having in-depth computer knowledge. Users are therefore
!! encouraged to load and test the software's suitability as regards their
!! requirements in conditions enabling the security of their systems and/or 
!! data to be ensured and,  more generally, to use and operate it in the 
!! same conditions as regards security. 
!! 
!! The fact that you are presently reading this means that you have had
!! knowledge of the CeCILL license and that you accept its terms.
!! =========================================================================

#include <inca_define.h>

SUBROUTINE CONF_CHEM(chemistry_couple) 

! Routine permettant de lire les parametres definis 
! dans le fichier texte inca.def

  USE PARAM_CHEM
  USE IOIPSL
  USE MOD_INCA_PARA


  IMPLICIT NONE

  LOGICAL, INTENT(in) :: chemistry_couple

  CHARACTER*(13), ALLOCATABLE, DIMENSION(:) :: tmp_emi_names_omp
  INTEGER :: i 


  LOGICAL :: xios_remap_output_omp, LMDZ_10m_winds_omp, CoupSurfAtm_omp, dep_orch_omp
  INTEGER :: feedb_omp, nbveget_omp, nbflux_omp
  INTEGER :: emi_interp_time_omp
  REAL :: tref_omp, ss_corr_omp
  LOGICAL :: multilayer_sediment_omp
  LOGICAL :: calcul_flux_omp
  CHARACTER(len=13) :: field_emi_names_omp
  CHARACTER(len=6) :: flag_o3_omp
  INTEGER :: flag_plane_omp, flag_plume_omp
  LOGICAL :: use_group_omp, cmip_xml


!$OMP MASTER

! default value for xios_remap_output
  xios_remap_output_omp=.TRUE.
! reading in inca.def if define
  CALL getin ('xios_remap_output',xios_remap_output_omp)  



! default value for LMDZ_10m_winds 
  LMDZ_10m_winds_omp=.FALSE.
! reading in inca.def if define
  CALL getin('LMDZ_10m_winds', LMDZ_10m_winds_omp) 

  ! default value for feedb
  feedb_omp=0
  ! reading in inca.def if define
  CALL getin('feedb', feedb_omp) 

  ! default value for tref (threshold parameter) 
  tref_omp=0.85
  ! reading in inca.def if define
  CALL getin('tref', tref_omp) 


  ! default value for ss_corr (correctif seasalt) 
  ss_corr_omp = 1. 
  call getin('ss_corr', ss_corr_omp) 


  ! choose if we run without plane (0) with old-aircraft routines (1) -  plane subsonic (2), hypersonic (3)
  flag_plane_omp=1
  CALL getin('flag_plane', flag_plane_omp)
#ifndef NMHC
  flag_plane_omp = 0 
#endif

  ! choose if we run with planes plume (1) or not (0) 
  flag_plume_omp=0
  CALL getin('flag_plume', flag_plume_omp) 

  !choose in mod without strat how we work for the o3 stratospheric (o3clim, o3lin)
  flag_o3_omp='o3clim'
  CALL getin('flag_o3', flag_o3_omp)
#ifdef STRAT
  flag_o3_omp='o3strt'
#endif

! Test pour le flag choisissant la sedimentation 
  multilayer_sediment_omp = .true.
  CALL getin('multilayer_sediment', multilayer_sediment_omp) 


! Test pour le calcul des flux en interactif 
  calcul_flux_omp = .false. 
  CALL getin('calcul_flux', calcul_flux_omp) 


  ! si 1 on garde les interpolations temporelles des emissions / si 0 on les annule / 2 on passe au nouveau schema d'interpolation 
  emi_interp_time_omp = 1
  CALL getin('emi_interp_time', emi_interp_time_omp)

  ! choose if we use groups in .xml files 
  cmip_xml = .FALSE. 
  call getin('cmip_xml', cmip_xml) 
  if (cmip_xml .eq. .FALSE.) then 
     use_group_omp = .TRUE. 
  else
     use_group_omp = .FALSE. 
  endif

!$OMP END MASTER
!$OMP BARRIER


  CALL bcast(xios_remap_output_omp)
  CALL bcast(LMDZ_10m_winds_omp) 
  CALL bcast(feedb_omp) 
  CALL bcast(tref_omp) 
  CALL bcast(ss_corr_omp)
  CALL bcast(flag_plane_omp)
  CALL bcast(flag_plume_omp)
  CALL bcast(flag_o3_omp)
  CALL bcast(multilayer_sediment_omp) 
  CALL bcast(calcul_flux_omp) 
  CALL bcast(emi_interp_time_omp) 
  CALL bcast(use_group_omp)


  xios_remap_output=xios_remap_output_omp
  LMDZ_10m_winds=LMDZ_10m_winds_omp
  feedb=feedb_omp
  tref=tref_omp
  ss_corr=ss_corr_omp
  flag_plane=flag_plane_omp
  flag_plume=flag_plume_omp
  flag_o3=flag_o3_omp
  multilayer_sediment = multilayer_sediment_omp 
  calcul_flux = calcul_flux_omp
  emi_interp_time = emi_interp_time_omp
  use_group = use_group_omp


    ! Coherence test between flag and preprocessing key
#ifndef XIOS
    IF (xios_inca_ok) THEN
       ! Write error messages and stop the model
       CALL print_err(3, 'CONF_CHEM', 'Preprocessing key XIOS is missing to run INCA with XIOS', &
            'Recompile with preprocessing flag XIOS or set XIOS_INCA_OK=n in run.def', '') 
    END IF
#endif

#ifndef AERONLY 
    IF (emi_interp_time .eq. 2) THEN 
       CALL print_err(3, 'CONF_CHEM', 'Preprocessing key AERONLY is missing to run INCA with emi_interp_time = 2 ', &
            'Recompile with the chemistry AER or change the flag emi_interp_time to 0 or 1', '')        
    END IF
#endif


  IF ((TRIM(flag_o3) .NE. 'o3strt') .AND. chemistry_couple ) THEN 
     CALL print_err(3, "CONF_CHEM", "you cannot use chemistry_couple for O3 ", &
          'if you not work with configuration NMHC_AER_S', '') 
  ENDIF

! ------------------------------------------------- 
! -------------------------------------------------
! Parametres pour le couplage avec orchidee
! ------------------------------------------------- 
! ------------------------------------------------- 
    ! Activation du couplage ou non 
!$OMP MASTER

    CoupSurfAtm_omp=.false. 
    call getin('CoupOrchInca', CoupSurfAtm_omp) 

    ! nombre de pft 
    ! il faut une valeur par defaut pour la def des axes en sorties 
    ! meme lorsqu'il n'y a pas de couplage orchidee
    !------------------------
    ! valeur par defaut
    nbveget_omp=13
    call getin('nbveget', nbveget_omp) 

    ! choix du depot entre celui de orchidee ou celui de inca 
    dep_orch_omp = .false. 
    call getin('DepOrch', dep_orch_omp) 


!$OMP END MASTER
!$OMP BARRIER
    CALL BCAST(CoupSurfAtm_omp) 
    CALL BCAST(nbveget_omp) 
    call bcast(dep_orch_omp) 

    CoupSurfAtm =CoupSurfAtm_omp
    nbveget=nbveget_omp
    dep_orch = dep_orch_omp


    IF (CoupSurfAtm) THEN 

!$OMP MASTER
       ! nombre de flux importes de orchidee 
       ! ------------------------------------
       ! valeur par defaut
       nbflux_omp = 23
       CALL getin('nbFlux_FromOrch', nbflux_omp) 
!$OMP END MASTER
!$OMP BARRIER
       CALL bcast(nbflux_omp) 
       nb_flux = nbflux_omp
  
       ! nom des flux importes de orchidee
       !------------------------------------
       IF (nb_flux .NE. 0) THEN 


          ALLOCATE(tmp_emi_names_omp(nb_flux)) 
          ALLOCATE(field_emi_names(nb_flux)) 
       
!$OMP MASTER
          if (nb_flux .eq. 23) THEN 
             ! valeur par defaut : 
             tmp_emi_names_omp(1) = "iso" 
             tmp_emi_names_omp(2) = "mono" 
             tmp_emi_names_omp(3) = "ORVOC" 
             tmp_emi_names_omp(4) = "MBO" 
             tmp_emi_names_omp(5) = "methanol" 
             tmp_emi_names_omp(6) = "acetone" 
             tmp_emi_names_omp(7) = "acetal" 
             tmp_emi_names_omp(8) = "formal" 
             tmp_emi_names_omp(9) = "acetic" 
             tmp_emi_names_omp(10) = "formic" 
             tmp_emi_names_omp(11) = "no_soil" 
             tmp_emi_names_omp(12) = "nox" 
             tmp_emi_names_omp(13) = "fertil_no" 
             tmp_emi_names_omp(14) = "apinen"
             tmp_emi_names_omp(15) = "bpinen"
             tmp_emi_names_omp(16) = "limonen"
             tmp_emi_names_omp(17) = "myrcen"
             tmp_emi_names_omp(18) = "sabinen"
             tmp_emi_names_omp(19) = "camphen"
             tmp_emi_names_omp(20) = "3caren"
             tmp_emi_names_omp(21) = "tbocimen"
             tmp_emi_names_omp(22) = "othermono"
             tmp_emi_names_omp(23) = "sesquiter"
          else 
             tmp_emi_names_omp(1) = "test"
          endif

          CALL getin('emi_FromOrch', tmp_emi_names_omp) 
!$OMP END MASTER
!$OMP BARRIER
          CALL bcast(tmp_emi_names_omp) 

          if (trim(tmp_emi_names_omp(1)) .eq. "test") then 
             call print_err(3, "conf_chem", "if nbflux .ne. 0 and nbflux .ne. 23", "you need to defined in inca.card the flux list ", "use emi_FromOrch parameter ") 
          endif

          DO i=1, nb_flux
             field_emi_names(i) = "flx_"//tmp_emi_names_omp(i)
          ENDDO

       ENDIF


    else
       nb_flux = 0. 
    endif

END SUBROUTINE CONF_CHEM