Cloud-J in GEOS-Chem Classic

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "docs/source/geos-chem-shared-docs"]
 	path = docs/source/geos-chem-shared-docs
 	url = https://github.com/geoschem/geos-chem-shared-docs.git
+[submodule "src/Cloud-J"]
+	path = src/Cloud-J
+	url = https://github.com/geoschem/Cloud-J.git

CHANGELOG.md

@@ -10,6 +10,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Changed
 - Updated GEOS-Chem submodule to 14.3.0
 
+### Added
+- Added Cloud-J submodule which is the new default photolysis package used in GEOS-Chem
+- Added compile option FASTJX to use legacy FAST-JX photolysis in GEOS-Chem instead of Cloud-J
+
 ## [14.2.3] - 2023-12-01
 ### Added
 - Script `.release/changeVersionNumbers.sh` to change version numbers before a new GEOS-Chem Classic release

CMakeLists.txt

@@ -233,6 +233,7 @@ endif()
 set(GCCLASSIC_WRAPPER TRUE)
 set(GC_EXTERNAL_CONFIG FALSE)
 set(HEMCO_EXTERNAL_CONFIG TRUE)
+set(CLOUDJ_EXTERNAL_CONFIG TRUE)
 
 #-----------------------------------------------------------------------------
 # Add the directory with source code

CMakeScripts/GC-ConfigureClassic.cmake

@@ -202,6 +202,20 @@ function(configureGCClassic)
         )
     endif()
 
+    #-------------------------------------------------------------------------
+    # Use Fast-JX rather than Cloud-J?
+    #-------------------------------------------------------------------------
+
+    set(FASTJX OFF CACHE BOOL
+        "Switch to use legacy FAST-JX in GEOS-Chem"
+    )
+    gc_pretty_print(VARIABLE FASTJX IS_BOOLEAN)
+    if(${FASTJX})
+        target_compile_definitions(GEOSChemBuildProperties
+            INTERFACE FASTJX
+        )
+    endif()
+
     #-------------------------------------------------------------------------
     # Export the following variables to GEOS-Chem directory's scope
     #-------------------------------------------------------------------------
@@ -214,6 +228,7 @@ function(configureGCClassic)
     set(GTMM                    ${GTMM}                     PARENT_SCOPE)
     set(LUO_WETDEP              ${LUO_WETDEP}               PARENT_SCOPE)
     set(SANITIZE                ${SANITIZE}                 PARENT_SCOPE)
+    set(FASTJX                  ${FASTJX}                   PARENT_SCOPE)
 
     #-------------------------------------------------------------------------
     # Export information about Git status

CMakeScripts/summarize_build

@@ -71,6 +71,7 @@ print_item_highlight RRTMG $(scrape_cache RRTMG)
 print_item_highlight GTMM $(scrape_cache GTMM)
 print_item_highlight HCOSA $(scrape_cache HCOSA)
 print_item_highlight LUO_WETDEP $(scrape_cache LUO_WETDEP)
+print_item_highlight FASTJX $(scrape_cache FASTJX)
 echo ""
 
 # grep --color "GEOSChem_Fortran_FLAGS_[A-Z_]*${COMPILER_ID}" $CACHEFILE

src/CMakeLists.txt

@@ -1,7 +1,7 @@
 # src/CMakeLists.txt
 
 #-----------------------------------------------------------------------------
-# Tell CMake to look for code in HEMCO and GEOS-Chem directory trees
+# Tell CMake to look for code in HEMCO, Cloud-J and GEOS-Chem directory trees
 #-----------------------------------------------------------------------------
 add_subdirectory(HEMCO     EXCLUDE_FROM_ALL)
 target_compile_definitions(HEMCOBuildProperties
@@ -11,6 +11,7 @@ target_compile_definitions(HEMCOBuildProperties
         $<$<STREQUAL:${TOMAS_BINS},40>:TOMAS40>
         ""
 )
+add_subdirectory(Cloud-J EXCLUDE_FROM_ALL)
 add_subdirectory(GEOS-Chem EXCLUDE_FROM_ALL)
 
 #-----------------------------------------------------------------------------