H2 Development Branch

CITATION.cff

@@ -1,4 +1,4 @@
-cff-version: 3.5.0
+cff-version: 3.5.6
 message: "If you use this software in your work, please cite it as below."
 authors:
 - family-names: "Dorheim"
@@ -34,7 +34,7 @@ authors:
   given-names: "Dawn"
   orcid: "https://orcid.org/0000-0002-0468-4660"
 title: "Hector a simple carbon-climate model"
-version: 3.5.0
+version: 3.5.6
 doi: 10.5281/zenodo.821645
 date-released: 2025-10-24
 url: "https://github.com/jgcri/hector"

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: hector
 Title: The Hector Simple Climate Model
-Version: 3.5.0
+Version: 3.5.6
 Authors@R: c(person("Kalyn", "Dorheim", 
 	        email = "kalyn.dorheim@pnnl.gov",
 	        role = c("aut", "cre"),

NAMESPACE

@@ -18,6 +18,7 @@ export(CH3BR_CONSTRAIN)
 export(CH3CCL3_CONSTRAIN)
 export(CH3CL_CONSTRAIN)
 export(CH4_CONSTRAIN)
+export(CH4_LIFETIME_OH)
 export(CO2_CONSTRAIN)
 export(CO3)
 export(CO3_HL)
@@ -76,6 +77,7 @@ export(EMISSIONS_CH3CCL3)
 export(EMISSIONS_CH3CL)
 export(EMISSIONS_CH4)
 export(EMISSIONS_CO)
+export(EMISSIONS_H2)
 export(EMISSIONS_HALON1211)
 export(EMISSIONS_HALON1301)
 export(EMISSIONS_HALON2402)

NEWS.md

@@ -1,3 +1,8 @@
+# hector 3.5.6 
+
+under development, adding H2 
+
+
 # hector 3.5.0 
 
 * Minor documentation changes 
@@ -10,9 +15,6 @@
 * New default parameter values for ocean heat diffusivity, CO2 fertilization, and heterotrophic respiration temperature sensitivity 
 
 
-
-
-
 # hector 3.2.0 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10698028.svg)](https://doi.org/10.5281/zenodo.10698028)
 

R/RcppExports.R

@@ -1082,6 +1082,18 @@ EMISSIONS_NMVOC <- function() {
     .Call('_hector_EMISSIONS_NMVOC', PACKAGE = 'hector')
 }
 
+#' @describeIn emissions Emissions hydrogen gas (\code{"Tg H2"})
+#' @export
+EMISSIONS_H2 <- function() {
+    .Call('_hector_EMISSIONS_H2', PACKAGE = 'hector')
+}
+
+#' @describeIn methane CH4 lifetime with respect to the OH sink (\code{"Yr"})
+#' @export
+CH4_LIFETIME_OH <- function() {
+    .Call('_hector_CH4_LIFETIME_OH', PACKAGE = 'hector')
+}
+
 #' @describeIn emissions Emissions for organic carbon (\code{"Tg"})
 #' @export
 EMISSIONS_OC <- function() {

data-raw/units-data.R

@@ -26,8 +26,8 @@ ch4_vars <- c(
 )
 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")

inst/include/component_data.hpp

@@ -65,9 +65,11 @@
 #define D_RHO_OC "rho_oc"            // BC radiative efficiency
 #define D_RHO_SO2 "rho_so2"          // SO2 radiative efficiency
 #define D_RHO_NH3 "rho_nh3"          // NH3 radiative efficiency
+#define D_RHO_H2O_H2 "rho_h2o_h2"    // radiative efficiency of H2 emissions on strat. H2O vapor
 #define D_AERO_SCALE "aero_scalar"
 #define D_VOLCANIC_SCALE "vol_scalar"
 
+
 // halocarbon components
 #define D_RF_CF4 D_RF_PREFIX CF4_COMPONENT_BASE
 #define D_RF_C2F6 D_RF_PREFIX C2F6_COMPONENT_BASE
@@ -279,13 +281,17 @@
 // oh component
 #define D_LIFETIME_OH "TAU_OH"
 #define D_INITIAL_LIFETIME_OH "TOH0"
-#define D_COEFFICENT_NOX "CNOX"
-#define D_COEFFICENT_CH4 "CCH4"
-#define D_COEFFICENT_NMVOC "CNMVOC"
-#define D_COEFFICENT_CO "CCO"
+#define D_COEFFICIENT_NOX "CNOX"
+#define D_COEFFICIENT_CH4 "CCH4"
+#define D_COEFFICIENT_NMVOC "CNMVOC"
+#define D_COEFFICIENT_CO "CCO"
+#define D_COEFFICIENT_H2 "H2_CCO"
+#define D_EMISSIONS_H2 "H2_emissions"
+
 
 // o3 component
 #define D_PREINDUSTRIAL_O3 "PO3"
+#define D_COEFF_O3_H2 "CO3_H2"
 #define D_ATMOSPHERIC_O3 "O3" CONCENTRATION_EXTENSION
 #define D_ATMOSPHERIC_EM_CH4 "CH4"
 #define D_EMISSIONS_NOX "NOX_emissions"

inst/include/forcing_component.hpp

@@ -109,6 +109,9 @@ class ForcingComponent : public IModelComponent {
   unitval delta_ch4; // forcing tropospheric adjustment for CH4 see 7.3.2.2 of
                      // IPCC AR6
 
+  // Stratospheric water vapor (strat. H2O) parameters
+  unitval rho_h2o_h2; // W m −2 per Tg yr− 1 from Sand et al. 2023
+
   // Aerosol parameters for aerosol-radiation interactions (RFari) see
   // equation 7.SM.1.1 of IPCC AR6
   unitval rho_bc; // (W yr m–2 Tg–1) IPCC AR6 radiative efficiency BC 7.SM.1.3

inst/include/h_util.hpp

@@ -26,7 +26,9 @@
  * \brief The model version number to be included in logs and outputs.
  * \note  Manually update the git tag to match this.
  */
-#define MODEL_VERSION "3.5.0"
+
+#define MODEL_VERSION "3.5.6"
+
 
 #define OUTPUT_DIRECTORY "output/"
 

inst/include/o3_component.hpp

@@ -58,10 +58,12 @@ class OzoneComponent : public IModelComponent {
 
   //! Current ozone concentration, relative to preindustrial, Dobson units
   unitval PO3;
+  unitval CO3_H2;
   tseries<unitval> O3;
   tseries<unitval> CO_emissions;
   tseries<unitval> NMVOC_emissions;
   tseries<unitval> NOX_emissions;
+  tseries<unitval> H2_emissions;
 
   //! logger
   Logger logger;

inst/include/oh_component.hpp

@@ -61,15 +61,18 @@ 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
   unitval TOH0; // preindustrial OH lifetime
 
-  double CCO;    // coefficent for CO
-  double CNMVOC; // coefficent for NMVOC
-  double CNOX;   // coefficent for NOX
-  double CCH4;   // coefficent for CH4
+  double CCO;    // coefficient for CO
+  double CNMVOC; // coefficient for NMVOC
+  double CNOX;   // coefficient for NOX
+  double CCH4;   // coefficient for CH4
+  unitval H2_CCO;   // adjust CO coefficient for H2
+
 
   // logger
   Logger logger;

inst/include/unitval.hpp

@@ -80,7 +80,9 @@ enum unit_types {
   U_TG_CH4,
   U_TG_N,
   U_TG_NMVOC,
+  U_TG_H2,
   U_DU_O3,
+  U_DU_O3_TG,
   U_GG_S, // SO2 emissions in Gg-S/yr
 
   U_TG_PPBV, // Conversion for CH4 and N2O emission to concentrations

inst/input/hector_picontrol.ini

@@ -114,9 +114,11 @@ CH4_emissions[1745]=0           ;
 
 ;------------------------------------------------------------------------
 [OH]
-NOX_emissions[1745]=3.877282     ; emissions time series
-CO_emissions[1745]=348.5273588      ; emissions time series
+
+NOX_emissions[1745]=3.877282         ; emissions time series
+CO_emissions[1745]=348.5273588       ; emissions time series
 NMVOC_emissions[1745]= 60.02182622   ; emissions time series
+H2_emissions[1745]=0     	     ; emissions time series
 
 
 TOH0=9.6			; initial OH lifetime (years) Wigley et al. 2002
@@ -128,6 +130,7 @@ CCH4=-0.32			; coefficient for CH4 (unitless) Wigley et al. 2002
 ;------------------------------------------------------------------------
 [ozone]
 PO3=30.0 					; preindustrial O3 concentration
+CO3_H2=4.09e-3 		       	; coefficient for H2 contribution to trop. O3 RF (DU O3 Tg H2-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 NOX_emissions[1745]=3.877282     ; emissions time series
 CO_emissions[1745]=348.5273588      ; emissions time series
 NMVOC_emissions[1745]= 60.02182622   ; emissions time series
@@ -160,6 +163,7 @@ rho_bc=0.0508           ; (W yr m–2 C Tg–1) IPCC AR6 radiative efficiency BC
 rho_oc=-.00621          ; (W yr m–2 C Tg–1) IPCC AR6 radiative efficiency OC (7.SM.1.3.1 of IPCC AR6)
 rho_so2=-.00000724      ; (W yr m–2 S Gg-1) IPCC AR6 radiative efficiency SO2 (7.SM.1.3.1 of IPCC AR6)
 rho_nh3=-.00208         ; (W yr m–2 NH3Tg–1) IPCC AR6 radiative efficiency NH3 (7.SM.1.3.1 of IPCC AR6)
+rho_h2o_h2=1.3e-4      ; (W m −2 H2 Tg-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 
 ; Miscellaneous radiative forcings default set to 0, or read in from a input table, may be used to read in
 ; additional forcings not modeled by Hector (i.e. solar, bc on snow , contrails from)

inst/input/hector_ssp119.ini

@@ -130,19 +130,24 @@ 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 TOH0=9.6			; initial OH lifetime (years) Wigley et al. 2002
 CNOX=8.4e-3			; coefficient for NOX, see PR #786
 CCO=-1.575e-4		; coefficient for CO, see PR #786
 CNMVOC=-4.725e-4	; coefficient for NMVOC (non methane VOC), see PR #786
 CCH4=-0.32			; coefficient for CH4 (unitless) Wigley et al. 2002
+H2_CCO=4.25         ; scaling factor for the CO coefficient that affects OH lifetime; see PR787
 
 ;------------------------------------------------------------------------
 [ozone]
 PO3=30.0 			; preindustrial O3 concentration
+CO3_H2=4.09e-3 		       	; coefficient for H2 contribution to trop. O3 RF (DU O3 Tg H2-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 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[1745]=0                                        ; assumed 0 emissions for the RCMIP era SSPs
+
 
 ;------------------------------------------------------------------------
 [N2O]
@@ -171,6 +176,8 @@ rho_bc=0.06386286       ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_oc=-0.006407143     ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_so2=-7.469841e-06   ; (W yr m–2 S Gg-1) Dorheim et al. 2024
 rho_nh3=-0.002146032    ; (W yr m–2 NH3Tg–1) Dorheim et al. 2024
+rho_h2o_h2=1.3e-4      ; (W m −2 H2 Tg-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
+
 
 ; Miscellaneous radiative forcings are by default zero, but can read in from a input table to
 ; represent additional forcings not modeled by Hector (e.g. solar, bc on snow, jet contrails)

inst/input/hector_ssp126.ini

@@ -130,19 +130,23 @@ 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 TOH0=9.6			; initial OH lifetime (years) Wigley et al. 2002
 CNOX=8.4e-3			; coefficient for NOX, see PR #786
 CCO=-1.575e-4		; coefficient for CO, see PR #786
 CNMVOC=-4.725e-4	; coefficient for NMVOC (non methane VOC), see PR #786
 CCH4=-0.32			; coefficient for CH4 (unitless) Wigley et al. 2002
+H2_CCO=4.25         ; scaling factor for the CO coefficient that affects OH lifetime; see PR787
 
 ;------------------------------------------------------------------------
 [ozone]
 PO3=30.0 			; preindustrial O3 concentration
+CO3_H2=4.09e-3 		       	; coefficient for H2 contribution to trop. O3 RF (DU O3 Tg H2-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 ;------------------------------------------------------------------------
 [N2O]
@@ -171,6 +175,8 @@ rho_bc=0.06386286       ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_oc=-0.006407143     ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_so2=-7.469841e-06   ; (W yr m–2 S Gg-1) Dorheim et al. 2024
 rho_nh3=-0.002146032    ; (W yr m–2 NH3Tg–1) Dorheim et al. 2024
+rho_h2o_h2=1.3e-4      ; (W m −2 H2 Tg-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
+
 
 ; Miscellaneous radiative forcings are by default zero, but can read in from a input table to
 ; represent additional forcings not modeled by Hector (e.g. solar, bc on snow, jet contrails)

inst/input/hector_ssp245.ini

@@ -130,19 +130,25 @@ 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
+
 
 TOH0=9.6			; initial OH lifetime (years) Wigley et al. 2002
 CNOX=8.4e-3			; coefficient for NOX, see PR #786
 CCO=-1.575e-4		; coefficient for CO, see PR #786
 CNMVOC=-4.725e-4	; coefficient for NMVOC (non methane VOC), see PR #786
 CCH4=-0.32			; coefficient for CH4 (unitless) Wigley et al. 2002
+H2_CCO=4.25         ; scaling factor for the CO coefficient that affects OH lifetime; see PR787
 
 ;------------------------------------------------------------------------
 [ozone]
-PO3=30.0 			; preindustrial O3 concentration
+PO3=30.0 			    ; preindustrial O3 concentration
+CO3_H2=4.09e-3 		       	; coefficient for H2 contribution to trop. O3 RF (DU O3 Tg H2-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
+
 
 ;------------------------------------------------------------------------
 [N2O]
@@ -171,6 +177,9 @@ rho_bc=0.06386286       ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_oc=-0.006407143     ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_so2=-7.469841e-06   ; (W yr m–2 S Gg-1) Dorheim et al. 2024
 rho_nh3=-0.002146032    ; (W yr m–2 NH3Tg–1) Dorheim et al. 2024
+rho_h2o_h2=1.3e-4      ; (W m −2 H2 Tg-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
+
+
 
 ; Miscellaneous radiative forcings are by default zero, but can read in from a input table to
 ; represent additional forcings not modeled by Hector (e.g. solar, bc on snow, jet contrails)

inst/input/hector_ssp370.ini

@@ -130,19 +130,23 @@ 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 TOH0=9.6			; initial OH lifetime (years) Wigley et al. 2002
 CNOX=8.4e-3			; coefficient for NOX, see PR #786
 CCO=-1.575e-4		; coefficient for CO, see PR #786
 CNMVOC=-4.725e-4	; coefficient for NMVOC (non methane VOC), see PR #786
 CCH4=-0.32			; coefficient for CH4 (unitless) Wigley et al. 2002
+H2_CCO=4.25         ; scaling factor for the CO coefficient that affects OH lifetime; see PR787
 
 ;------------------------------------------------------------------------
 [ozone]
 PO3=30.0 			; preindustrial O3 concentration
+CO3_H2=4.09e-3 		       	; coefficient for H2 contribution to trop. O3 RF (DU O3 Tg H2-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 ;------------------------------------------------------------------------
 [N2O]
@@ -171,6 +175,8 @@ rho_bc=0.06386286       ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_oc=-0.006407143     ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_so2=-7.469841e-06   ; (W yr m–2 S Gg-1) Dorheim et al. 2024
 rho_nh3=-0.002146032    ; (W yr m–2 NH3Tg–1) Dorheim et al. 2024
+rho_h2o_h2=1.3e-4      ; (W m −2 H2 Tg-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
+
 
 ; Miscellaneous radiative forcings are by default zero, but can read in from a input table to
 ; represent additional forcings not modeled by Hector (e.g. solar, bc on snow, jet contrails)

inst/input/hector_ssp434.ini

@@ -130,19 +130,23 @@ 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 TOH0=9.6			; initial OH lifetime (years) Wigley et al. 2002
 CNOX=8.4e-3			; coefficient for NOX, see PR #786
 CCO=-1.575e-4		; coefficient for CO, see PR #786
 CNMVOC=-4.725e-4	; coefficient for NMVOC (non methane VOC), see PR #786
 CCH4=-0.32			; coefficient for CH4 (unitless) Wigley et al. 2002
+H2_CCO=4.25         ; scaling factor for the CO coefficient that affects OH lifetime; see PR787
 
 ;------------------------------------------------------------------------
 [ozone]
 PO3=30.0 			; preindustrial O3 concentration
+CO3_H2=4.09e-3 		       	; coefficient for H2 contribution to trop. O3 RF (DU O3 Tg H2-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
 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[1745]=0                                         ; assumed 0 emissions for the RCMIP era SSPs
 
 ;------------------------------------------------------------------------
 [N2O]
@@ -171,6 +175,8 @@ rho_bc=0.06386286       ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_oc=-0.006407143     ; (W yr m–2 C Tg–1) Dorheim et al. 2024
 rho_so2=-7.469841e-06   ; (W yr m–2 S Gg-1) Dorheim et al. 2024
 rho_nh3=-0.002146032    ; (W yr m–2 NH3Tg–1) Dorheim et al. 2024
+rho_h2o_h2=1.3e-4      ; (W m −2 H2 Tg-1) Sand et al. 2023 ST4, 10.1038/s43247-023-00857-8
+
 
 ; Miscellaneous radiative forcings are by default zero, but can read in from a input table to
 ; represent additional forcings not modeled by Hector (e.g. solar, bc on snow, jet contrails)