Merge pull request #25 from PecanProject/ORG78_Finish_sipnet_wiring

ORG78 Finish event wiring in SIPNET

Author: Alomir

exitCodes.h

@@ -0,0 +1,21 @@
+#ifndef EXITCODES_H
+#define EXITCODES_H
+
+// Exit codes for SIPNET; most of the current uses of exit(1) should
+// get better codes, which will appear here.
+//
+// Note for future: some codes typically have other meanings and should not be
+// used here (except for 0 and 1, for which our meaning is the usual meaning).
+// Some somewhat-standard codes in use:
+// - 0-2, 126-165, and 255; see, e.g., https://tldp.org/LDP/abs/html/exitcodes.html
+// - 64-78, see https://man7.org/linux/man-pages/man3/sysexits.h.3head.html
+//
+// The upshot here is that we should be a little sparing in our list of error codes.
+typedef enum {
+  EXIT_CODE_SUCCESS = 0,
+  EXIT_CODE_FAILURE = 1, // generic failure
+  // code 2 typically has a special meaning, see above
+  EXIT_CODE_UNKNOWN_EVENT = 3
+} exit_code_t;
+
+#endif

sipnet.c

@@ -20,6 +20,7 @@
 #include "outputItems.h"
 #include "modelStructures.h"
 #include "events.h"
+#include "exitCodes.h"
 
 // begin definitions for choosing different model structures
 // (1 -> true, 0 -> false)
@@ -491,6 +492,7 @@ static double *outputPtrs[MAX_DATA_TYPES]; // pointers to different possible out
 
 #if EVENT_HANDLER
 static EventNode **events;
+static EventNode *locEvent; // current location event list
 #endif
 
 /* Read climate file into linked lists,
@@ -2275,54 +2277,103 @@ void updateTrackers(double oldSoilWater) {
   // mean of soil wetness at start of time step at soil wetness at end of time step - assume linear
 }
 
+// This should be in events.h/c, but with all the global state defined in this file,
+// let's leave it here for now. Maybe someday we will factor that out.
+//
+// Process events for current location/year/day
+#if EVENT_HANDLER
+void processEvents() {
+  // If locEvent starts off NULL, this function will just fall through, as it should.
+  const int year = climate->year;
+  const int day = climate->day;
+
+  // The events file has been tested on read, so we know this event list should be in chrono
+  // order. However, we need to check to make sure the current event is not in the past, as
+  // that would indicate an event that did not have a corresponding climate file record.
+  while (locEvent != NULL && locEvent->year <= year && locEvent->day <= day) {
+    if (locEvent->year < year || locEvent->day < day) {
+      printf("Agronomic event found for loc: %d year: %d day: %d that does not have a corresponding record in the climate file\n", locEvent->year, locEvent->year, locEvent->day);
+      exit(1);
+    }
+    switch (locEvent->type) {
+      // Implementation TBD, as we enable the various event types
+      case IRRIGATION:
+        // TBD
+          printf("Irrigation events not yet implemented\n");
+          break;
+      case PLANTING:
+        // TBD
+          printf("Planting events not yet implemented\n");
+          break;
+      case HARVEST:
+        // TBD
+          printf("Harvest events not yet implemented\n");
+          break;
+      case TILLAGE:
+        // TBD
+          printf("Tillage events not yet implemented\n");
+          break;
+      case FERTILIZATION:
+        // TBD
+          printf("Fertilization events not yet implemented\n");
+          break;
+      default:
+        printf("Unknown event type (%d) in processEvents()\n", locEvent->type);
+        exit(EXIT_CODE_UNKNOWN_EVENT);
+    }
 
-// !!! main runner function !!!
+    locEvent = locEvent->nextEvent;
+  }
+}
+#endif
 
 
+// !!! main runner function !!!
 
 // calculate all fluxes and update state for this time step
 // we calculate all fluxes before updating state in case flux calculations depend on the old state
 void updateState() {
-	double npp; // net primary productivity, g C * m^-2 ground area * day^-1
-  	double oldSoilWater; // how much soil water was there before we updated it? Used in trackers
-    int err;
-  	oldSoilWater = envi.soilWater;
-
-  	calculateFluxes();
-
-  	// update the stocks, with fluxes adjusted for length of time step:
-  	envi.plantWoodC += (fluxes.photosynthesis + fluxes.woodCreation - fluxes.leafCreation - fluxes.woodLitter
-  				- fluxes.rVeg-fluxes.coarseRootCreation-fluxes.fineRootCreation)* climate->length;
-  	envi.plantLeafC += (fluxes.leafCreation - fluxes.leafLitter) * climate->length;
-
-
+  double npp; // net primary productivity, g C * m^-2 ground area * day^-1
+  double oldSoilWater; // how much soil water was there before we updated it? Used in trackers
+  int err;
+  oldSoilWater = envi.soilWater;
 
+  calculateFluxes();
 
-	soilDegradation();		// This updates all the soil functions
+  // update the stocks, with fluxes adjusted for length of time step:
+  envi.plantWoodC += (fluxes.photosynthesis + fluxes.woodCreation - fluxes.leafCreation - fluxes.woodLitter
+        - fluxes.rVeg-fluxes.coarseRootCreation-fluxes.fineRootCreation)* climate->length;
+  envi.plantLeafC += (fluxes.leafCreation - fluxes.leafLitter) * climate->length;
 
+  soilDegradation();    // This updates all the soil functions
 
+  #if MODEL_WATER // water pool updating happens here:
 
-	#if MODEL_WATER // water pool updating happens here:
+    #if LITTER_WATER // (2 soil water layers; litter water will only be on if complex water is also on)
+        envi.litterWater += (fluxes.rain + fluxes.snowMelt - fluxes.immedEvap - fluxes.fastFlow
+             - fluxes.evaporation - fluxes.topDrainage) * climate->length;
+        envi.soilWater += (fluxes.topDrainage - fluxes.transpiration - fluxes.bottomDrainage)
+        * climate->length;
 
-		#if LITTER_WATER // (2 soil water layers; litter water will only be on if complex water is also on)
-  			envi.litterWater += (fluxes.rain + fluxes.snowMelt - fluxes.immedEvap - fluxes.fastFlow
-		    	   - fluxes.evaporation - fluxes.topDrainage) * climate->length;
-  			envi.soilWater += (fluxes.topDrainage - fluxes.transpiration - fluxes.bottomDrainage)
-    		* climate->length;
+    #else // LITTER_WATER = 0 (only one soil water layer)
+      // note: some of these fluxes will always be 0 if complex water is off
+        envi.soilWater += (fluxes.rain + fluxes.snowMelt - fluxes.immedEvap - fluxes.fastFlow
+          - fluxes.evaporation - fluxes.transpiration - fluxes.bottomDrainage) * climate->length;
+    #endif // LITTER_WATER
 
-		#else // LITTER_WATER = 0 (only one soil water layer)
-  		// note: some of these fluxes will always be 0 if complex water is off
-  			envi.soilWater += (fluxes.rain + fluxes.snowMelt - fluxes.immedEvap - fluxes.fastFlow
-		     	- fluxes.evaporation - fluxes.transpiration - fluxes.bottomDrainage) * climate->length;
-		#endif // LITTER_WATER
+      // if COMPLEX_WATER = 0 or SNOW = 0, some or all of these fluxes will always be 0
+      envi.snow += (fluxes.snowFall - fluxes.snowMelt - fluxes.sublimation) * climate->length;
 
-  		// if COMPLEX_WATER = 0 or SNOW = 0, some or all of these fluxes will always be 0
-  		envi.snow += (fluxes.snowFall - fluxes.snowMelt - fluxes.sublimation) * climate->length;
-
-	#endif // MODEL_WATER
+  #endif // MODEL_WATER
 
   ensureNonNegativeStocks();
 
+#if EVENT_HANDLER
+  // Process events for this location/year/day, AFTER updates are made to fluxes and state
+  // variables above. Events are (currently, Jan 25, 2025) handled as instantaneous deltas to
+  // relevant state (envi and fluxes fields),
+  processEvents();
+#endif
 
   npp = fluxes.photosynthesis - fluxes.rVeg-fluxes.rCoarseRoot-fluxes.rFineRoot;
 
@@ -2343,7 +2394,6 @@ void updateState() {
   }
 
   updateTrackers(oldSoilWater);
-
 }
 
 
@@ -2484,9 +2534,11 @@ void setupModel(SpatialParams *spatialParams, int loc) {
 
 
 // Setup events at given location
+#if EVENT_HANDLER
 void setupEvents(int currLoc) {
-  // Implementation TBD
+  locEvent = events[currLoc];
 }
+#endif
 
 
 /* Do one run of the model using parameter values in spatialParams
@@ -2554,6 +2606,12 @@ void runModelNoOut(double **outArray, int numDataTypes, int dataTypeIndices[], S
 
   setupModel(spatialParams, loc);
 
+#if EVENT_HANDLER
+  // Implementation TBD
+  printf("Event handler not yet implemented for running model with no output\n");
+  exit(1);
+#endif
+
   // loop through every step of the model:
   while (climate != NULL) {
     updateState();