Enable global mean surface temperature as Hector output (#701)

Save global mean surface temperature and return it as Hector output. Update the Hector version in preparation for a new release.

Author: kdorheim

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: hector
 Title: The Hector Simple Climate Model
-Version: 3.0.1
+Version: 3.1.0
 Authors@R: c(person("Kalyn", "Dorheim", 
 	        email = "[email protected]",
 	        role = c("aut", "cre"),

NAMESPACE

@@ -107,6 +107,7 @@ export(F_LITTERD)
 export(F_NPPD)
 export(F_NPPV)
 export(GLOBAL_TAS)
+export(GMST)
 export(HALON1211_CONSTRAIN)
 export(HALON1301_CONSTRAIN)
 export(HALON2402_CONSTRAIN)

NEWS.md

@@ -1,3 +1,7 @@
+# hector 3.1.0 
+
+Return global mean surface temperature as a Hector output.
+
 # hector 3.0.1
 
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7617326.svg)](https://doi.org/10.5281/zenodo.7617326)

R/RcppExports.R

@@ -1498,6 +1498,12 @@ GLOBAL_TAS <- function() {
     .Call('_hector_GLOBAL_TAS', PACKAGE = 'hector')
 }
 
+#' @describeIn temperature Global mean surface temperature anomaly
+#' @export
+GMST <- function() {
+    .Call('_hector_GMST', PACKAGE = 'hector')
+}
+
 #' @describeIn temperature Average sea surface temperature anomaly
 #' @export
 SST <- function() {

inst/include/component_data.hpp

@@ -394,6 +394,7 @@
 #define D_LAND_TAS "land_tas"
 #define D_SST "sst"
 #define D_OCEAN_TAS "ocean_tas"
+#define D_GMST "gmst"
 #define D_LO_WARMING_RATIO "lo_warming_ratio"
 #define D_DIFFUSIVITY "diff"
 #define D_AERO_SCALE "alpha"

inst/include/temperature_component.hpp

@@ -133,6 +133,7 @@ class TemperatureComponent : public IModelComponent {
 
   // Time series arrays that are updated with each DOECLIM time-step
   std::vector<double> temp;
+  std::vector<double> temp_surface;
   std::vector<double> temp_landair;
   std::vector<double> temp_sst;
   std::vector<double> heatflux_mixed;
@@ -148,7 +149,8 @@ class TemperatureComponent : public IModelComponent {
   unitval volscl; //!< volcanic forcing scaling factor, unitless
 
   // Model outputs
-  unitval tas;       //!< global average surface air temperature anomaly, deg C
+  unitval tas;       //!< global average air temperature anomaly, deg C
+  unitval gmst_val; //!< global average surface temperature anomaly, deg C
   unitval tas_land;  //!< average air temperature anomaly over land, deg C
   unitval tas_ocean; //!< global average ocean surface air temperature anomaly,
                      //!< deg C

man/temperature.Rd

@@ -2507,6 +2507,16 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// GMST
+String GMST();
+RcppExport SEXP _hector_GMST() {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    rcpp_result_gen = Rcpp::wrap(GMST());
+    return rcpp_result_gen;
+END_RCPP
+}
 // SST
 String SST();
 RcppExport SEXP _hector_SST() {
@@ -2993,6 +3003,7 @@ static const R_CallMethodDef CallEntries[] = {
     {"_hector_AERO_SCALE", (DL_FUNC) &_hector_AERO_SCALE, 0},
     {"_hector_VOLCANIC_SCALE", (DL_FUNC) &_hector_VOLCANIC_SCALE, 0},
     {"_hector_GLOBAL_TAS", (DL_FUNC) &_hector_GLOBAL_TAS, 0},
+    {"_hector_GMST", (DL_FUNC) &_hector_GMST, 0},
     {"_hector_SST", (DL_FUNC) &_hector_SST, 0},
     {"_hector_OCEAN_TAS", (DL_FUNC) &_hector_OCEAN_TAS, 0},
     {"_hector_LAND_TAS", (DL_FUNC) &_hector_LAND_TAS, 0},

src/RcppExports.cpp

@@ -231,6 +231,7 @@ void CSVOutputStreamVisitor::visit(TemperatureComponent *c) {
   if (!core->outputEnabled(c->getComponentName()))
     return;
   STREAM_MESSAGE(csvFile, c, D_GLOBAL_TAS);
+  STREAM_MESSAGE(csvFile, c, D_GMST);
   STREAM_MESSAGE(csvFile, c, D_FLUX_MIXED);
   STREAM_MESSAGE(csvFile, c, D_FLUX_INTERIOR)
   STREAM_MESSAGE(csvFile, c, D_HEAT_FLUX);

src/csv_outputstream_visitor.cpp

@@ -1444,6 +1444,11 @@ String VOLCANIC_SCALE() { return D_VOLCANIC_SCALE; }
 // [[Rcpp::export]]
 String GLOBAL_TAS() { return D_GLOBAL_TAS; }
 
+//' @describeIn temperature Global mean surface temperature anomaly
+//' @export
+// [[Rcpp::export]]
+String GMST() { return D_GMST; }
+
 //' @describeIn temperature Average sea surface temperature anomaly
 //' @export
 // [[Rcpp::export]]