Adds explanatory comments about the output holding process

uaf-arctic-eco-modeling · Nov 30, 2021 · a2a157a · a2a157a
1 parent 67a2a1a
commit a2a157a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/include/OutputHolder.h b/include/OutputHolder.h
@@ -1,4 +1,13 @@
 
+/* When running a region with many concurrent batches, outputting at every
+ * year timestep creates a bottleneck in the run. Output at the monthly
+ * timestep is correspondingly worse.
+ *
+ * This class is a basic repository for output data to be held until
+ * outputting is triggered based on the user's specifications.
+ * */
+
+
 #ifndef OUTPUTHOLDER_H
 #define OUTPUTHOLDER_H
 

diff --git a/src/Runner.cpp b/src/Runner.cpp
@@ -1016,6 +1016,11 @@ void Runner::output_nc_5dim(OutputSpec* out_spec, std::string stage_suffix,
 }
 
 
+/* Some of the following outputs are written out at the timesteps
+ * they have specified in the output_spec file, but some have
+ * been converted to write to an OutputHolder in order to reduce
+ * the amount of file I/O that occurs during a large run. The period
+ * of time to hold data is specified in the config file. */
 void Runner::output_netCDF(std::map<std::string, OutputSpec> &netcdf_outputs, int year, int month, std::string stage, int endyr){
   int month_timestep = year*12 + month;