Getting Hector set up for H2 emissions (#751)

Expose oh lifetime or oh tau to R bindings so it is easy to fetch output, add H2 unit testing, and expose R bindings.
JGCRI · Oct 15, 2024 · 1e15620 · 1e15620
1 parent 1ef0b4d
commit 1e15620
Show file tree

Hide file tree

Showing 30 changed files with 4,877 additions and 4,743 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -125,6 +125,7 @@ export(HFC32_CONSTRAIN)
 export(HFC4310_CONSTRAIN)
 export(HL_OCEAN_UPTAKE)
 export(LAND_TAS)
+export(LIFETIME_OH)
 export(LIFETIME_SOIL)
 export(LIFETIME_STRAT)
 export(LL_DEBUG)

diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -1,6 +1,9 @@
 # Generated by using Rcpp::compileAttributes() -> do not edit by hand
 # Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393
 
+#' @describeIn emissions Emissions hydrogen gas (\code{"Tg H2"})
+NULL
+
 #' @describeIn msgtype Message type for retrieving data from a component
 #' @keywords internal
 GETDATA <- function() {
@@ -1082,6 +1085,16 @@ EMISSIONS_NMVOC <- function() {
     .Call('_hector_EMISSIONS_NMVOC', PACKAGE = 'hector')
 }
 
+EMISSIONS_H2 <- function() {
+    .Call('_hector_EMISSIONS_H2', PACKAGE = 'hector')
+}
+
+#' @describeIn oh OH lifetime (\code{"Yr"})
+#' @export
+LIFETIME_OH <- function() {
+    .Call('_hector_LIFETIME_OH', PACKAGE = 'hector')
+}
+
 #' @describeIn emissions Emissions for organic carbon (\code{"Tg"})
 #' @export
 EMISSIONS_OC <- function() {

diff --git a/data-raw/input_params.csv b/data-raw/input_params.csv
diff --git a/data-raw/units-data.R b/data-raw/units-data.R
@@ -20,8 +20,8 @@ ch4_vars <- c(PREINDUSTRIAL_CH4(), NATURAL_CH4(), EMISSIONS_CH4(), CH4_CONSTRAIN
               LIFETIME_SOIL(), LIFETIME_STRAT())
 ch4_uni <- c("ppbv CH4", "Tg CH4", "Tg CH4", "ppbv CH4", "Years", "Years")
 
-oh_vars <- c(EMISSIONS_NOX(), EMISSIONS_CO(), EMISSIONS_NMVOC())
-oh_uni <- c("Tg N", "Tg CO", "Tg NMVOC")
+oh_vars <- c(EMISSIONS_NOX(), EMISSIONS_CO(), EMISSIONS_NMVOC(), EMISSIONS_H2())
+oh_uni <- c("Tg N", "Tg CO", "Tg NMVOC", "Tg H2")
 
 n2o_vars <- c(EMISSIONS_N2O(), N2O_CONSTRAIN(), NAT_EMISSIONS_N2O(), PREINDUSTRIAL_N2O())
 n2o_uni <- c("Tg N", "ppbv N2O", "Tg N", "ppbv N2O")

diff --git a/data/inputstable.rda b/data/inputstable.rda
diff --git a/data/unitstable.rda b/data/unitstable.rda
diff --git a/inst/include/component_data.hpp b/inst/include/component_data.hpp
@@ -281,6 +281,8 @@
 #define D_COEFFICENT_CH4 "CCH4"
 #define D_COEFFICENT_NMVOC "CNMVOC"
 #define D_COEFFICENT_CO "CCO"
+#define D_EMISSIONS_H2 "H2_emissions"
+
 
 // o3 component
 #define D_PREINDUSTRIAL_O3 "PO3"

diff --git a/inst/include/oh_component.hpp b/inst/include/oh_component.hpp
@@ -61,6 +61,7 @@ class OHComponent : public IModelComponent {
   tseries<unitval> CO_emissions;
   tseries<unitval> NOX_emissions;
   tseries<unitval> NMVOC_emissions;
+  tseries<unitval> H2_emissions;
   tseries<unitval> TAU_OH;
 
   unitval M0;   // initial CH4 concentration

diff --git a/inst/include/unitval.hpp b/inst/include/unitval.hpp
@@ -80,6 +80,7 @@ enum unit_types {
   U_TG_CH4,
   U_TG_N,
   U_TG_NMVOC,
+  U_TG_H2,
   U_DU_O3,
   U_GG_S, // SO2 emissions in Gg-S/yr
 

diff --git a/inst/input/hector_ssp119.ini b/inst/input/hector_ssp119.ini
@@ -130,6 +130,8 @@ CH4_emissions=csv:tables/ssp119_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp119_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp119_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
+
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp126.ini b/inst/input/hector_ssp126.ini
@@ -130,6 +130,7 @@ CH4_emissions=csv:tables/ssp126_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp126_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp126_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp126_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp245.ini b/inst/input/hector_ssp245.ini
@@ -130,6 +130,8 @@ CH4_emissions=csv:tables/ssp245_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp245_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp245_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp245_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
+
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp370.ini b/inst/input/hector_ssp370.ini
@@ -130,6 +130,8 @@ CH4_emissions=csv:tables/ssp370_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp370_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp370_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp370_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
+
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp434.ini b/inst/input/hector_ssp434.ini
@@ -130,6 +130,8 @@ CH4_emissions=csv:tables/ssp434_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp434_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp434_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp434_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
+
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp460.ini b/inst/input/hector_ssp460.ini
@@ -130,6 +130,8 @@ CH4_emissions=csv:tables/ssp460_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp460_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp460_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp460_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
+
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp534-over.ini b/inst/input/hector_ssp534-over.ini
@@ -130,6 +130,8 @@ CH4_emissions=csv:tables/ssp534-over_emiss-constraints_rf.csv     ; emissions ti
 NOX_emissions=csv:tables/ssp534-over_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp534-over_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp534-over_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv           ; emissions time series
+
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX

diff --git a/inst/input/hector_ssp585.ini b/inst/input/hector_ssp585.ini
@@ -130,6 +130,7 @@ CH4_emissions=csv:tables/ssp585_emiss-constraints_rf.csv     ; emissions time se
 NOX_emissions=csv:tables/ssp585_emiss-constraints_rf.csv     ; emissions time series
 CO_emissions=csv:tables/ssp585_emiss-constraints_rf.csv      ; emissions time series
 NMVOC_emissions=csv:tables/ssp585_emiss-constraints_rf.csv   ; emissions time series
+H2_emissions=csv:tables/ssp119_emiss-constraints_rf.csv      ; emissions time series
 
 TOH0=6.6			; inital OH lifetime (years)
 CNOX=0.0042			; coefficent for NOX