Merge pull request #298 from JGCRI/land-ocean-branch

Report land and ocean temperatures

Version 2.2.1

Author: rplzzz

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: hector
 Title: The Hector Simple Climate Model
-Version: 2.2.0
+Version: 2.2.1
 Authors@R: c(person("Robert", "Link", email = "[email protected]", role = c("aut", "cre")),
 	     person("Corinne", "Hartin", email = "[email protected]", role = "aut"),
 	     person("Ben", "Bond-Lamberty", email = "[email protected]", role = "aut"),
@@ -21,6 +21,8 @@ Suggests:
     knitr,
     rmarkdown,
     ggplot2,
+    tidyr (>= 0.7),
+    dplyr (>= 0.7),
     hectortools
 Remotes:
     jgcri/hectortools

NAMESPACE

@@ -64,6 +64,7 @@ export(GLOBAL_TEMP)
 export(GLOBAL_TEMPEQ)
 export(HEAT_FLUX)
 export(LAND_CFLUX)
+export(LAND_TEMP)
 export(LIFETIME_SOIL)
 export(LIFETIME_STRAT)
 export(LL_DEBUG)
@@ -73,12 +74,14 @@ export(LL_WARNING)
 export(LUC_EMISSIONS)
 export(NATURAL_CH4)
 export(NATURAL_SO2)
+export(OCEAN_AIR_TEMP)
 export(OCEAN_C)
 export(OCEAN_CFLUX)
 export(OCEAN_C_DO)
 export(OCEAN_C_HL)
 export(OCEAN_C_IO)
 export(OCEAN_C_LL)
+export(OCEAN_SURFACE_TEMP)
 export(PCO2_HL)
 export(PCO2_LL)
 export(PH_HL)

R/RcppExports.R

@@ -790,6 +790,24 @@ GLOBAL_TEMPEQ <- function() {
     .Call('_hector_GLOBAL_TEMPEQ', PACKAGE = 'hector')
 }
 
+#' @describeIn temperature Average ocean surface temperature anomaly
+#' @export
+OCEAN_SURFACE_TEMP <- function() {
+    .Call('_hector_OCEAN_SURFACE_TEMP', PACKAGE = 'hector')
+}
+
+#' @describeIn temperature Average ocean air temperature anomaly
+#' @export
+OCEAN_AIR_TEMP <- function() {
+    .Call('_hector_OCEAN_AIR_TEMP', PACKAGE = 'hector')
+}
+
+#' @describeIn temperature Average land temperature anomaly
+#' @export
+LAND_TEMP <- function() {
+    .Call('_hector_LAND_TEMP', PACKAGE = 'hector')
+}
+
 #' @describeIn parameters Ocean heat diffusivity (\code{"cm2/s"})
 #' @export
 DIFFUSIVITY <- function() {

changelog.txt

@@ -1,3 +1,9 @@
+Hector 2.2.1
+============
+* Report global averages for land temperature, ocean air
+  temperature, and ocean surface temperature.
+* Fix bug that prevented CH4 emissions from being read.
+
 Hector 2.2.0
 ============
 * Add a new parameter: VOLCANIC_SCALE.  This parameter adjusts the

inst/include/component_data.hpp

@@ -242,6 +242,9 @@
 // temperature component
 #define D_ECS                   "S"
 #define D_GLOBAL_TEMP           "Tgav"
+#define D_LAND_TEMP             "Tgav_land"
+#define D_OCEAN_SURFACE_TEMP    "Tgav_ocean_ST"
+#define D_OCEAN_AIR_TEMP        "Tgav_ocean_air"
 #define D_GLOBAL_TEMPEQ         "Tgaveq"
 #define D_TGAV_CONSTRAIN        "tgav_constrain"
 #define D_SO2D_B                "so2d_b"

inst/include/h_util.hpp

@@ -26,7 +26,7 @@
  * \brief The model version number to be included in logs and outputs.
  * \note This must be updated manually when the model version changes.
  */
-#define MODEL_VERSION "2.2.0"
+#define MODEL_VERSION "2.2.1"
 
 #define OUTPUT_DIRECTORY "output/"
 

inst/include/temperature_component.hpp

@@ -137,7 +137,10 @@ class TemperatureComponent : public IModelComponent {
     unitval volscl;        //!< volcanic forcing scaling factor, unitless
 
     // Model outputs
-    unitval tgav;          //!< global temperature delta, deg C
+    unitval tgav;          //!< global average surface air temperature anomaly, deg C
+    unitval tgav_land;     //!< global average land surface air temperature anomaly, deg C
+    unitval tgav_oceanair; //!< global average ocean surface air temperature anomaly, deg C
+    unitval tgav_sst;      //!< global average ocean surface (water) temperature anomaly, deg C
     unitval tgaveq;        //!< equilibrium temp without ocean heat flux, currently set = tgav
     unitval flux_mixed;    //!< heat flux into mixed layer of ocean, W/m2
     unitval flux_interior; //!< heat flux into interior layer of ocean, W/m2

man/temperature.Rd

@@ -1315,6 +1315,36 @@ BEGIN_RCPP
     return rcpp_result_gen;
 END_RCPP
 }
+// OCEAN_SURFACE_TEMP
+String OCEAN_SURFACE_TEMP();
+RcppExport SEXP _hector_OCEAN_SURFACE_TEMP() {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    rcpp_result_gen = Rcpp::wrap(OCEAN_SURFACE_TEMP());
+    return rcpp_result_gen;
+END_RCPP
+}
+// OCEAN_AIR_TEMP
+String OCEAN_AIR_TEMP();
+RcppExport SEXP _hector_OCEAN_AIR_TEMP() {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    rcpp_result_gen = Rcpp::wrap(OCEAN_AIR_TEMP());
+    return rcpp_result_gen;
+END_RCPP
+}
+// LAND_TEMP
+String LAND_TEMP();
+RcppExport SEXP _hector_LAND_TEMP() {
+BEGIN_RCPP
+    Rcpp::RObject rcpp_result_gen;
+    Rcpp::RNGScope rcpp_rngScope_gen;
+    rcpp_result_gen = Rcpp::wrap(LAND_TEMP());
+    return rcpp_result_gen;
+END_RCPP
+}
 // DIFFUSIVITY
 String DIFFUSIVITY();
 RcppExport SEXP _hector_DIFFUSIVITY() {
@@ -1575,6 +1605,9 @@ static const R_CallMethodDef CallEntries[] = {
     {"_hector_VOLCANIC_SCALE", (DL_FUNC) &_hector_VOLCANIC_SCALE, 0},
     {"_hector_GLOBAL_TEMP", (DL_FUNC) &_hector_GLOBAL_TEMP, 0},
     {"_hector_GLOBAL_TEMPEQ", (DL_FUNC) &_hector_GLOBAL_TEMPEQ, 0},
+    {"_hector_OCEAN_SURFACE_TEMP", (DL_FUNC) &_hector_OCEAN_SURFACE_TEMP, 0},
+    {"_hector_OCEAN_AIR_TEMP", (DL_FUNC) &_hector_OCEAN_AIR_TEMP, 0},
+    {"_hector_LAND_TEMP", (DL_FUNC) &_hector_LAND_TEMP, 0},
     {"_hector_DIFFUSIVITY", (DL_FUNC) &_hector_DIFFUSIVITY, 0},
     {"_hector_FLUX_MIXED", (DL_FUNC) &_hector_FLUX_MIXED, 0},
     {"_hector_FLUX_INTERIOR", (DL_FUNC) &_hector_FLUX_INTERIOR, 0},

src/RcppExports.cpp

@@ -172,6 +172,9 @@ unitval CH4Component::getData( const std::string& varName,
     } else if( varName == D_PREINDUSTRIAL_CH4 ) {
         H_ASSERT( date == Core::undefinedIndex(), "Date not allowed for preindustrial CH4" );
         returnval = M0;
+    } else if( varName == D_EMISSIONS_CH4 ) {
+        H_ASSERT(  date != Core::undefinedIndex(), "Date not allowed for CH4 emissions" );
+        returnval = CH4_emissions.get( date );
     } else {
         H_THROW( "Caller is requesting unknown variable: " + varName );
     }