Code cleanup 1 for PR

Author: Alomir

events.c

@@ -142,9 +142,6 @@ EventNode** readEventData(char *eventFile, int numLocs) {
   currYear = year;
   currDay = day;
 
-  //printf("Found events:\n");
-  //printEvent(next);
-
   while (fgets(line, EVENT_LINE_SIZE, in) != NULL) {
     // We have another event
     curr = next;
@@ -171,7 +168,6 @@ EventNode** readEventData(char *eventFile, int numLocs) {
     }
 
     next = createEventNode(loc, year, day, eventType, eventParamsStr);
-    //printEvent(next);
     if (currLoc == loc) {
       // Same location, add the new event to this location's list
       curr->nextEvent = next;

events.h

@@ -55,11 +55,12 @@ struct EventNode {
   EventNode *nextEvent;
 };
 
-/* Read event data from <FILENAME>.event
+/* Read event data from input filename (canonically events.in)
  *
  * Format: returned data is structured as an array of EventNode pointers, indexed by
  * location. Each element of the array is the first event for that location (or null
- * if there are no events). It is assumed that the events are in chrono order.
+ * if there are no events). It is assumed that the events are ordered first by location
+ * and then by year and day.
  */
 EventNode** readEventData(char *eventFile, int numLocs);
 

frontend.c

@@ -82,7 +82,7 @@ int main(int argc, char *argv[]) {
   double **standarddevs;
   int dataTypeIndices[MAX_DATA_TYPES];
 
-#ifdef EVENT_HANDLER
+#if EVENT_HANDLER
 	// Extra filename if we are handing events
 	char eventFile[FILE_MAXNAME+24];
 #endif

modelStructures.h

@@ -11,7 +11,8 @@
 // See also sipnet.c for other options (that should be moved here if/when testing is added)
 
 #define EVENT_HANDLER 0
-// Read in and process agronomic events. Expects a file named <FILENAME>.event to exist.
+// Read in and process agronomic events. SIPNET expects a file named events.in to exist, though
+// unit tests may use other names.
 
 
 #endif //MODEL_STRUCTURES_H

sipnet.c

@@ -489,8 +489,8 @@ static ClimateNode *climate; // current climate
 static Fluxes fluxes;
 static double *outputPtrs[MAX_DATA_TYPES]; // pointers to different possible outputs
 
-#ifdef EVENT_HANDLER
-static EventNode **events; // MJL: event structs
+#if EVENT_HANDLER
+static EventNode **events;
 #endif
 
 /* Read climate file into linked lists,
@@ -1936,8 +1936,8 @@ void calculateFluxes() {
   	double potGrossPsn; // potential photosynthesis, without water stress
   	double dWater;
   	double lai; // m^2 leaf/m^2 ground (calculated from plantLeafC)
-  	//double litterBreakdown; /* total litter breakdown (i.e. litterToSoil + rLitter)
-		//					 (g C/m^2 ground/day) */
+    //double litterBreakdown; /* total litter breakdown (i.e. litterToSoil + rLitter)
+    //(g C/m^2 ground/day) */
   	double folResp, woodResp; // maintenance respiration terms, g C * m^-2 ground area * day^-1
   	double litterWater, soilWater; /* amount of water in litter and soil (cm)
 				    taken from either environment or climate drivers, depending on value of MODEL_WATER */
@@ -2485,7 +2485,7 @@ void setupModel(SpatialParams *spatialParams, int loc) {
 
 // Setup events at given location
 void setupEvents(int currLoc) {
-
+  // Implementation TBD
 }
 
 
@@ -2514,8 +2514,8 @@ void runModelOutput(FILE *out, OutputItems *outputItems, int printHeader, Spatia
 
   for (currLoc = firstLoc; currLoc <= lastLoc; currLoc++) {
     setupModel(spatialParams, currLoc);
-#ifdef EVENT_HANDLER
-  	setupEvents(currLoc);
+#if EVENT_HANDLER
+    setupEvents(currLoc);
 #endif
     if ((loc == -1) && (outputItems != NULL))  {  // print the current location at the start of the line
       sprintf(label, "%d", currLoc);
@@ -2525,15 +2525,16 @@ void runModelOutput(FILE *out, OutputItems *outputItems, int printHeader, Spatia
     while (climate != NULL) {
       updateState();
       if (out != NULL) {
-	      outputState(out, currLoc, climate->year, climate->day, climate->time);
+        outputState(out, currLoc, climate->year, climate->day, climate->time);
       }
       if (outputItems != NULL) {
-	      writeOutputItemValues(outputItems);
+        writeOutputItemValues(outputItems);
       }
       climate = climate->nextClim;
     }
-    if (outputItems != NULL)
+    if (outputItems != NULL) {
       terminateOutputItemLines(outputItems);
+    }
   }
 }
 
@@ -2794,7 +2795,7 @@ int initModel(SpatialParams **spatialParams, int **steps, char *paramFile, char
  * Populates static event structs
  */
 void initEvents(char *eventFile, int numLocs) {
-#ifdef EVENT_HANDLER
+#if EVENT_HANDLER
 	events = readEventData(eventFile, numLocs);
 #endif
 }

sipnet.h

@@ -52,7 +52,14 @@ char **getDataTypeNames();
 int initModel(SpatialParams **spatialParams, int **steps, char *paramFile, char *climFile);
 
 /*
- * TBD
+ * Read in event data for all the model runs
+ *
+ * Read in event data from a file with the following specification:
+ * - one line per event
+ * - all events are ordered first by location (ascending) and then by year/day (ascending)
+ *
+ * @param eventFile Name of file containing event data
+ * @param numLocs Number of locations in the event file.
  */
 void initEvents(char *eventFile, int numLocs);
 

tests/sipnet/exitHandler.c

@@ -1,9 +1,11 @@
 #include <setjmp.h>
 #include <unistd.h>
 
+//
+
 static int expected_code = 1;  // the expected value a tested function passes to exit
-static int should_exit = 1;    // 1 if exit should have been called
-static int really_exit = 0;           // set to 1 to prevent stubbing behavior and actually exit
+static int should_exit = 1;    // set in test code; 1 if exit should have been called
+static int really_exit = 0;    // set to 1 to prevent stubbing behavior and actually exit
 
 static jmp_buf jump_env;
 
@@ -19,7 +21,7 @@ static int exit_result = 1;
 // }
 // test_assert(jmp_rval==0);
 //
-// set should_exit=1 when exit(0 is expected:
+// set should_exit=1 when exit is expected:
 //
 // should_exit = 1;
 // expected_code = 1; // or whatever the exit code should be
@@ -40,8 +42,6 @@ void exit(int code)
     test_assert(expected_code==code);
     longjmp(jump_env, 1);
   }
-  else
-  {
-    _exit(code);
-  }
+
+  _exit(code);
 }

tests/test.template

@@ -34,4 +34,4 @@ int main() {
   }
 
   cleanup();
-}
+}