Change events.out to pool amounts instead of fluxes (#349)

Alomir · web-flow · commit 7b3420c40985 · 2026-07-07T15:24:55.000-04:00
* Change events.out to pool amounts instead of fluxes

* Update events.out example

* events.out change

* Update events.out after change to pool amounts

* Update for calcLeafOnOff format change in events.out

* Updates for events.out format change
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -37,6 +37,7 @@ sections to include in release notes:
 ### Changed
 
 - Renamed the CLI option `--file-name` to `--file-prefix` for clarity while keeping `--file-name` as a backward-compatible alias (#320)
+- Values in `events.out` changed to pool deltas rather than flux amounts (#349)
 
 ### Removed
 
diff --git a/docs/user-guide/model-outputs.md b/docs/user-guide/model-outputs.md
@@ -65,7 +65,7 @@ When event handling is enabled, SIPNET will create `events.out` by default, or
 This file is designed primarily for _testing and debugging_.  
 It contains one row for each agronomic event that is processed. 
 Each row lists the year, day, event type, and parameter name/value pairs. 
-The name/value pairs represent the state variables that are directly changed by an event, recording the change (delta) applied to each.
+The name/value pairs represent the change to a pool directly calculated from an event.
 
 Information in the events output file can, in principle, be reconstructed or
 inferred from the corresponding events input file and `sipnet.out` though this
@@ -78,10 +78,10 @@ Note the delimiters: spaces separate columns, commas separate name/value pairs,
 
 ```
 year  day  type     param_name=delta[,param_name=delta,...]
-2023   65  plant    envi.plantLeafC=3.00,envi.plantWoodC=4.00,envi.fineRootC=5.00,envi.coarseRootC=6.00
-2023   70  irrig    envi.soilWater=5.00
-2023  200  harv     env.litter=5.46,envi.plantLeafC=-5.93,envi.plantWoodC=-4.75,envi.fineRootC=-3.73,envi.coarseRootC=-3.89
-2024   65  plant    envi.plantLeafC=3.00,envi.plantWoodC=5.00,envi.fineRootC=7.00,envi.coarseRootC=9.00
-2024   70  irrig    fluxes.immedEvap=2.50,envi.soilWater=2.50
-2024  200  harv     env.litter=4.25,envi.plantLeafC=-1.39,envi.plantWoodC=-1.63,envi.fineRootC=-2.52,envi.coarseRootC=-2.97
+2023   65  plant    eventLeafC=3.00,eventWoodC=4.00,eventFineRootC=5.00,eventCoarseRootC=6.00,eventInputC=18.00,eventInputN=0.00
+2023   70  irrig    eventSoilWater=5.00,eventEvap=0.00
+2023  200  harv     eventSoilC=1.90,eventLitterC=3.56,eventLeafC=-5.93,eventWoodC=-4.75,eventFineRootC=-3.73,eventCoarseRootC=-3.89,eventSoilOrgN=0.00,eventLitterN=0.00,eventOutputC=12.83,eventOutputN=0.00
+2024   65  plant    eventLeafC=3.00,eventWoodC=5.00,eventFineRootC=7.00,eventCoarseRootC=9.00,eventInputC=24.00,eventInputN=0.00
+2024   70  irrig    eventSoilWater=2.50,eventEvap=2.50
+2024  200  harv     eventSoilC=2.74,eventLitterC=1.51,eventLeafC=-1.39,eventWoodC=-1.63,eventFineRootC=-2.52,eventCoarseRootC=-2.97,eventSoilOrgN=0.00,eventLitterN=0.00,eventOutputC=4.25,eventOutputN=0.00
 ```
diff --git a/src/sipnet/events.c b/src/sipnet/events.c
@@ -486,8 +486,8 @@ void processEvents(void) {
         }
         fluxes.eventEvap += evapAmount / climLen;
         fluxes.eventSoilWater += soilAmount / climLen;
-        writeEventOut(gEvent, 2, "fluxes.eventSoilWater", soilAmount / climLen,
-                      "fluxes.eventEvap", evapAmount / climLen);
+        writeEventOut(gEvent, 2, "eventSoilWater", soilAmount, "eventEvap",
+                      evapAmount);
       } break;
       case PLANTING: {
         const PlantingParams *plantParams = gEvent->eventParams;
@@ -515,12 +515,15 @@ void processEvents(void) {
           fluxes.eventInputN += inputN / climLen;
         }
 
-        writeEventOut(gEvent, 6, "fluxes.eventLeafC", leafC / climLen,
-                      "fluxes.eventWoodC", woodC / climLen,
-                      "fluxes.eventFineRootC", fineRootC / climLen,
-                      "fluxes.eventCoarseRootC", coarseRootC / climLen,
-                      "fluxes.eventInputC", inputC / climLen,
-                      "fluxes.eventInputN", inputN / climLen);
+        // clang-format off
+        writeEventOut(gEvent, 6,
+                      "eventLeafC", leafC,
+                      "eventWoodC", woodC,
+                      "eventFineRootC", fineRootC,
+                      "eventCoarseRootC", coarseRootC,
+                      "eventInputC", inputC,
+                      "eventInputN", inputN);
+        // clang-format on
       } break;
       case HARVEST: {
         // Harvest can both remove biomass and move biomass to the soil/litter
@@ -592,16 +595,16 @@ void processEvents(void) {
         // clang-format off
         writeEventOut(
             gEvent, 10,
-            "fluxes.eventSoilC", soilAdd / climLen,
-            "fluxes.eventLitterC", litterAdd / climLen,
-            "fluxes.eventLeafC", leafDelta / climLen,
-            "fluxes.eventWoodC", woodDelta / climLen,
-            "fluxes.eventFineRootC", fineDelta / climLen,
-            "fluxes.eventCoarseRootC", coarseDelta / climLen,
-            "fluxes.eventSoilOrgN", soilNAdd / climLen,
-            "fluxes.eventLitterN", litterNAdd / climLen,
-            "fluxes.eventOutputC", outputC / climLen,
-            "fluxes.eventOutputN", outputN / climLen);
+            "eventSoilC", soilAdd,
+            "eventLitterC", litterAdd,
+            "eventLeafC", leafDelta,
+            "eventWoodC", woodDelta,
+            "eventFineRootC", fineDelta,
+            "eventCoarseRootC", coarseDelta,
+            "eventSoilOrgN", soilNAdd,
+            "eventLitterN", litterNAdd,
+            "eventOutputC", outputC,
+            "eventOutputN", outputN);
         // clang-format on
       } break;
       case TILLAGE: {
@@ -646,12 +649,12 @@ void processEvents(void) {
 
         // clang-format off
         writeEventOut(gEvent, 6,
-          "fluxes.eventLitterC", ctx.litterPool ? orgC / climLen : 0.0,
-          "fluxes.eventSoilC", ctx.litterPool ? 0.0 : orgC / climLen,
-          "fluxes.eventMinN", minN / climLen,
-          "fluxes.eventLitterN", orgN / climLen,
-          "fluxes.eventInputC", orgC / climLen,
-          "fluxes.eventInputN", (orgN + minN) / climLen);
+          "eventLitterC", ctx.litterPool ? orgC : 0.0,
+          "eventSoilC", ctx.litterPool ? 0.0 : orgC,
+          "eventMinN", minN,
+          "eventLitterN", orgN,
+          "eventInputC", orgC,
+          "eventInputN", (orgN + minN));
         // clang-format on
       } break;
       case LEAFON: {
@@ -692,9 +695,9 @@ void processEvents(void) {
 
         // clang-format off
         writeEventOut(gEvent, 3,
-          "fluxes.eventLeafOffLitter", leafOff / climLen,
-          "fluxes.eventLeafOffNResorption", leafNResorption / climLen,
-          "fluxes.eventLitterN", litterNAdd / climLen);
+          "eventLeafOffLitter", leafOff,
+          "eventLeafOffNResorption", leafNResorption,
+          "eventLitterN", litterNAdd);
         // clang-format on
       } break;
       default:
diff --git a/src/sipnet/sipnet.c b/src/sipnet/sipnet.c
@@ -836,7 +836,8 @@ void calcLeafOnOffFluxes(double *leafOnCreation, double *leafOnFromWood,
   // check for end of growing season:
   if (!phenologyTrackers.didLeafFall && pastLeafFall()) {
     // we just reached the end of the growing season
-    double leafOff = (plantLeafC * params.fracLeafFall) / climate->length;
+    double len = climate->length;
+    double leafOff = (plantLeafC * params.fracLeafFall) / len;
     *leafLitter += leafOff;
     phenologyTrackers.didLeafFall = 1;
     if (leafOff > TINY && ctx.events) {
@@ -846,8 +847,8 @@ void calcLeafOnOffFluxes(double *leafOnCreation, double *leafOnFromWood,
         *leafOffNResorption += nResorp;
       }
       writeComputedEventOut(climate->year, climate->day,
-                            eventTypeToString(LEAFOFF), 2, "fluxes.leafLitter",
-                            leafOff, "fluxes.leafOffNResorption", nResorp);
+                            eventTypeToString(LEAFOFF), 2, "leafLitter",
+                            leafOff * len, "leafOffNResorption", nResorp * len);
     }
   }
 }
@@ -1250,19 +1251,20 @@ void resetFluxes(void) { fluxes = (struct FluxVars){0}; }
  */
 void writeLeafOnEventIfNeeded(void) {
   const char *type = eventTypeToString(LEAFON);
+  const double len = climate->length;
   if (fluxes.leafOnCreation > TINY && ctx.events) {
     writeComputedEventOut(climate->year, climate->day, type, 2,
-                          "fluxes.leafOnCreation", fluxes.leafOnCreation,
-                          "fluxes.leafOnCreationFromWood",
-                          fluxes.leafOnCreationFromWood);
+                          "leafOnCreation", fluxes.leafOnCreation * len,
+                          "leafOnCreationFromWood",
+                          fluxes.leafOnCreationFromWood * len);
   }
   if (fluxes.eventLeafOnCreation > TINY && ctx.events) {
     // Not really a computed event, but we don't have the event object here, so
     // we use this mechanism
     writeComputedEventOut(
-        climate->year, climate->day, type, 2, "fluxes.eventLeafOnCreation",
-        fluxes.eventLeafOnCreation, "fluxes.eventLeafOnCreationFromWood",
-        fluxes.eventLeafOnCreationFromWood);
+        climate->year, climate->day, type, 2, "eventLeafOnCreation",
+        fluxes.eventLeafOnCreation * len, "eventLeafOnCreationFromWood",
+        fluxes.eventLeafOnCreationFromWood * len);
   }
 }
 
diff --git a/tests/sipnet/test_events_infrastructure/events_output_header.out b/tests/sipnet/test_events_infrastructure/events_output_header.out
@@ -1,7 +1,7 @@
 year  day  type     param_name=delta[,param_name=delta,...]
-2023   65  plant    fluxes.eventLeafC=6.00,fluxes.eventWoodC=8.00,fluxes.eventFineRootC=10.00,fluxes.eventCoarseRootC=12.00,fluxes.eventInputC=36.00,fluxes.eventInputN=0.00
-2023   70  irrig    fluxes.eventSoilWater=10.00,fluxes.eventEvap=0.00
-2023  200  harv     fluxes.eventSoilC=3.81,fluxes.eventLitterC=7.12,fluxes.eventLeafC=-11.86,fluxes.eventWoodC=-9.50,fluxes.eventFineRootC=-7.46,fluxes.eventCoarseRootC=-7.78,fluxes.eventSoilOrgN=0.00,fluxes.eventLitterN=0.00,fluxes.eventOutputC=25.66,fluxes.eventOutputN=0.00
-2024   65  plant    fluxes.eventLeafC=6.00,fluxes.eventWoodC=10.00,fluxes.eventFineRootC=14.00,fluxes.eventCoarseRootC=18.00,fluxes.eventInputC=48.00,fluxes.eventInputN=0.00
-2024   70  irrig    fluxes.eventSoilWater=5.00,fluxes.eventEvap=5.00
-2024  200  harv     fluxes.eventSoilC=5.48,fluxes.eventLitterC=3.02,fluxes.eventLeafC=-2.78,fluxes.eventWoodC=-3.27,fluxes.eventFineRootC=-5.04,fluxes.eventCoarseRootC=-5.93,fluxes.eventSoilOrgN=0.00,fluxes.eventLitterN=0.00,fluxes.eventOutputC=8.51,fluxes.eventOutputN=0.00
+2023   65  plant    eventLeafC=3.00,eventWoodC=4.00,eventFineRootC=5.00,eventCoarseRootC=6.00,eventInputC=18.00,eventInputN=0.00
+2023   70  irrig    eventSoilWater=5.00,eventEvap=0.00
+2023  200  harv     eventSoilC=1.90,eventLitterC=3.56,eventLeafC=-5.93,eventWoodC=-4.75,eventFineRootC=-3.73,eventCoarseRootC=-3.89,eventSoilOrgN=0.00,eventLitterN=0.00,eventOutputC=12.83,eventOutputN=0.00
+2024   65  plant    eventLeafC=3.00,eventWoodC=5.00,eventFineRootC=7.00,eventCoarseRootC=9.00,eventInputC=24.00,eventInputN=0.00
+2024   70  irrig    eventSoilWater=2.50,eventEvap=2.50
+2024  200  harv     eventSoilC=2.74,eventLitterC=1.51,eventLeafC=-1.39,eventWoodC=-1.63,eventFineRootC=-2.52,eventCoarseRootC=-2.97,eventSoilOrgN=0.00,eventLitterN=0.00,eventOutputC=4.25,eventOutputN=0.00
diff --git a/tests/sipnet/test_events_infrastructure/events_output_no_header.out b/tests/sipnet/test_events_infrastructure/events_output_no_header.out
@@ -1,6 +1,6 @@
-2023   65  plant    fluxes.eventLeafC=20.00,fluxes.eventWoodC=10.00,fluxes.eventFineRootC=8.00,fluxes.eventCoarseRootC=6.00,fluxes.eventInputC=44.00,fluxes.eventInputN=0.00
-2023   70  irrig    fluxes.eventSoilWater=10.00,fluxes.eventEvap=0.00
-2023  200  harv     fluxes.eventSoilC=24.80,fluxes.eventLitterC=0.00,fluxes.eventLeafC=-9.60,fluxes.eventWoodC=-6.40,fluxes.eventFineRootC=-9.60,fluxes.eventCoarseRootC=-9.60,fluxes.eventSoilOrgN=0.00,fluxes.eventLitterN=0.00,fluxes.eventOutputC=10.40,fluxes.eventOutputN=0.00
-2024   65  plant    fluxes.eventLeafC=20.00,fluxes.eventWoodC=10.00,fluxes.eventFineRootC=8.00,fluxes.eventCoarseRootC=6.00,fluxes.eventInputC=44.00,fluxes.eventInputN=0.00
-2024   70  irrig    fluxes.eventSoilWater=5.00,fluxes.eventEvap=5.00
-2024  200  harv     fluxes.eventSoilC=24.28,fluxes.eventLitterC=0.00,fluxes.eventLeafC=-20.64,fluxes.eventWoodC=-11.76,fluxes.eventFineRootC=-5.76,fluxes.eventCoarseRootC=-4.96,fluxes.eventSoilOrgN=0.00,fluxes.eventLitterN=0.00,fluxes.eventOutputC=18.84,fluxes.eventOutputN=0.00
+2023   65  plant    eventLeafC=10.00,eventWoodC=5.00,eventFineRootC=4.00,eventCoarseRootC=3.00,eventInputC=22.00,eventInputN=0.00
+2023   70  irrig    eventSoilWater=5.00,eventEvap=0.00
+2023  200  harv     eventSoilC=12.40,eventLitterC=0.00,eventLeafC=-4.80,eventWoodC=-3.20,eventFineRootC=-4.80,eventCoarseRootC=-4.80,eventSoilOrgN=0.00,eventLitterN=0.00,eventOutputC=5.20,eventOutputN=0.00
+2024   65  plant    eventLeafC=10.00,eventWoodC=5.00,eventFineRootC=4.00,eventCoarseRootC=3.00,eventInputC=22.00,eventInputN=0.00
+2024   70  irrig    eventSoilWater=2.50,eventEvap=2.50
+2024  200  harv     eventSoilC=12.14,eventLitterC=0.00,eventLeafC=-10.32,eventWoodC=-5.88,eventFineRootC=-2.88,eventCoarseRootC=-2.48,eventSoilOrgN=0.00,eventLitterN=0.00,eventOutputC=9.42,eventOutputN=0.00
diff --git a/tests/smoke/russell_1/events.out b/tests/smoke/russell_1/events.out
diff --git a/tests/smoke/russell_2/events.out b/tests/smoke/russell_2/events.out
diff --git a/tests/smoke/russell_3/events.out b/tests/smoke/russell_3/events.out
