Retire CO2, CH4, and tagged CO simulations

The CO2, CH4, and tagged CO simulation options have been removed from GEOS-Chem. All run directory files specific to those simulations have been removed for GCClassic, GCHP, and WRF. GCHP also offered a "CO2 with CMS fluxes" simulation option for testing the GCHP adjoint, but this is outdates and has been removed here. Further testing on these simulations should utilize the carbon simulation either in joint (CO2-CH4-CO-OCS) or single-species mode. Modules co2_mod.F90, global_ch4_mod.F90, and tagged_co_mod.F90 have been deleted. Those files contained mainly hardcoded chemistry, which is now applied in KPP and carbon_gases_mod.F90 via the carbon simulation. Signed-off-by: Melissa Sulprizio <[email protected]>
geoschem · Jan 15, 2025 · a83c0c9 · a83c0c9
1 parent b0e03cc
commit a83c0c9
Show file tree

Hide file tree

Showing 65 changed files with 88 additions and 11,935 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,11 @@ This file documents all notable changes to the GEOS-Chem repository starting in
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased - TBD
+### Removed
+- Retired the CO2, CH4, and tagCO simulations. These are now replaced by the carbon simulation, which can be used in joint or single-species mode.
+- Deleted `co2_mod.F90`, `global_ch4_mod.F90`, and `tagged_co_mod.F90`
+
 ## [14.5.1] - 2025-01-10
 ### Added
 - Added Australian Hg emissions for 2000-2019 from MacFarlane et. al. [2022], plus corresponding mask file

diff --git a/GeosCore/CMakeLists.txt b/GeosCore/CMakeLists.txt
@@ -28,7 +28,6 @@ add_library(GeosCore
   cldice_HBrHOBr_rxn.F90
   cldj_interface_mod.F90
   cleanup.F90
-  co2_mod.F90
   convection_mod.F90
   depo_mercury_mod.F90
   diagnostics_mod.F90
@@ -41,7 +40,6 @@ add_library(GeosCore
   gc_environment_mod.F90
   get_ndep_mod.F90
   global_br_mod.F90
-  global_ch4_mod.F90
   gosat_ch4_mod.F90
   hcoi_gc_diagn_mod.F90
   hco_state_gc_mod.F90
@@ -70,7 +68,6 @@ add_library(GeosCore
   set_global_ch4_mod.F90
   sfcvmr_mod.F90
   sulfate_mod.F90
-  tagged_co_mod.F90
   tagged_o3_mod.F90
   tccon_ch4_mod.F90
   toms_mod.F90

diff --git a/GeosCore/carbon_gases_mod.F90 b/GeosCore/carbon_gases_mod.F90
@@ -7,8 +7,8 @@
 !
 ! !DESCRIPTION: Module CARBON_GASES_MOD contains variables and routines
 ! for simulating CH4, CO, CO2, and OCS with an online calculation of the
-! chemistry between them using KPP. It was adapted directly from
-! the module CH4_CO_CO2_MOD.F provided by Beata Bukosa.
+! chemistry between them using KPP. It was adapted directly from code
+! provided by Beata Bukosa.
 !\\
 !\\
 ! !INTERFACE:

diff --git a/GeosCore/chemistry_mod.F90 b/GeosCore/chemistry_mod.F90
@@ -64,7 +64,6 @@ SUBROUTINE Do_Chemistry( Input_Opt,  State_Chm, State_Diag,                &
     USE ErrCode_Mod
     USE ERROR_MOD
     USE FullChem_Mod,     ONLY : Do_FullChem
-    USE GLOBAL_CH4_MOD,   ONLY : CHEMCH4
     USE Input_Opt_Mod,    ONLY : OptInput
     USE AEROSOL_THERMODYNAMICS_MOD,  ONLY : DO_ATE
     USE LINEAR_CHEM_MOD,  ONLY : DO_LINEAR_CHEM
@@ -79,7 +78,6 @@ SUBROUTINE Do_Chemistry( Input_Opt,  State_Chm, State_Diag,                &
     USE State_Diag_Mod,   ONLY : DgnState
     USE State_Grid_Mod,   ONLY : GrdState
     USE State_Met_Mod,    ONLY : MetState
-    USE TAGGED_CO_MOD,    ONLY : CHEM_TAGGED_CO
     USE TAGGED_O3_MOD,    ONLY : CHEM_TAGGED_O3
     USE TIME_MOD,         ONLY : GET_TS_CHEM
     USE Tracer_Mod,       ONLY : Tracer_Sink_Phase
@@ -945,46 +943,6 @@ SUBROUTINE Do_Chemistry( Input_Opt,  State_Chm, State_Diag,                &
 
           ENDIF
 
-       !=====================================================================
-       ! Tagged CO
-       !=====================================================================
-       ELSE IF ( Input_Opt%ITS_A_TAGCO_SIM ) THEN
-
-          ! Do tagged CO chemistry
-          CALL Chem_Tagged_CO( Input_Opt  = Input_Opt,                       &
-                               State_Chm  = State_Chm,                       &
-                               State_Diag = State_Diag,                      &
-                               State_Grid = State_Grid,                      &
-                               State_Met  = State_Met,                       &
-                               RC         = RC                              )
-
-          ! Trap potential errors
-          IF ( RC /= GC_SUCCESS ) THEN
-             ErrMsg = 'Error encountered in "Chem_Tagged_CO"!'
-             CALL GC_Error( ErrMsg, RC, ThisLoc )
-             RETURN
-          ENDIF
-
-       !=====================================================================
-       ! CH4
-       !=====================================================================
-       ELSE IF ( Input_Opt%ITS_A_CH4_SIM ) THEN
-
-          ! Do CH4 chemistry
-          CALL ChemCh4( Input_Opt  = Input_Opt,                              &
-                        State_Chm  = State_Chm,                              &
-                        State_Diag = State_Diag,                             &
-                        State_Grid = State_Grid,                             &
-                        State_Met  = State_Met,                              &
-                        RC         = RC                                     )
-
-          ! Trap potential errors
-          IF ( RC /= GC_SUCCESS ) THEN
-             ErrMsg = 'Error encountered in "ChemCh4"!'
-             CALL GC_Error( ErrMsg, RC, ThisLoc )
-             RETURN
-          ENDIF
-
        !=====================================================================
        ! Carbon gases (configure with -DMECH=carbon)
        !=====================================================================

diff --git a/GeosCore/cleanup.F90 b/GeosCore/cleanup.F90
@@ -17,7 +17,6 @@ SUBROUTINE CLEANUP( Input_Opt, State_Grid, ERROR, RC )
 !
   USE CARBON_MOD,              ONLY : CLEANUP_CARBON
   USE Carbon_Gases_Mod,        ONLY : Cleanup_Carbon_Gases
-  USE CO2_MOD,                 ONLY : CLEANUP_CO2
   USE DEPO_MERCURY_MOD,        ONLY : CLEANUP_DEPO_MERCURY
   USE DRYDEP_MOD,              ONLY : CLEANUP_DRYDEP
   USE DUST_MOD,                ONLY : CLEANUP_DUST
@@ -41,7 +40,6 @@ SUBROUTINE CLEANUP( Input_Opt, State_Grid, ERROR, RC )
   USE SEASALT_MOD,             ONLY : CLEANUP_SEASALT
   USE SULFATE_MOD,             ONLY : CLEANUP_SULFATE
   USE State_Grid_Mod,          ONLY : GrdState
-  USE TAGGED_CO_MOD,           ONLY : CLEANUP_TAGGED_CO
   USE EMISSIONS_MOD,           ONLY : EMISSIONS_FINAL
   USE SFCVMR_MOD,              ONLY : FixSfcVmr_Final
   USE VDiff_Mod,               ONLY : Cleanup_Vdiff