Create a "Progress" netCDF

include/SW_datastructs.h

@@ -769,7 +769,8 @@ typedef struct {
 	Bool stopRun;           // Specifies if an error has occurred and
                             // the program needs to stop early (backtrack)
 
-  Bool QuietMode; /**< Don't print version, error message, or notify user about logfile (only used by SOILWAT2) */
+  Bool QuietMode, /**< Don't print version, error message, or notify user about logfile (only used by SOILWAT2) */
+    printProgressMsg; /**< Do/don't print progress messages to the console */
 } LOG_INFO;
 
 typedef struct {

include/filefuncs.h

@@ -32,6 +32,7 @@ Bool MkDir(const char *dname, LOG_INFO* LogInfo);
 Bool RemoveFiles(const char *fspec, LOG_INFO* LogInfo);
 Bool CopyFile(const char *from, const char *to, LOG_INFO* LogInfo);
 void LogError(LOG_INFO* LogInfo, const int mode, const char *fmt, ...);
+void sw_message(const char *msg);
 
 int key_to_id(const char* key, const char **possibleKeys,
                      int numPossKeys);

src/SW_Control.c

@@ -222,6 +222,12 @@ void SW_CTL_RunSimSet(SW_ALL *sw_template, SW_OUTPUT_POINTERS SW_OutputPtrs[],
 
     set_walltime(&tss, &ok_tss);
 
+    #if defined(SOILWAT)
+    if(main_LogInfo->printProgressMsg) {
+        sw_message("is running simulations across the domain ...");
+    }
+    #endif
+
     /* Loop over suids in simulation set of domain */
     for(suid = SW_Domain->startSimSet; suid < SW_Domain->endSimSet; suid++)
     {
@@ -238,6 +244,8 @@ void SW_CTL_RunSimSet(SW_ALL *sw_template, SW_OUTPUT_POINTERS SW_OutputPtrs[],
 
         LOG_INFO local_LogInfo;
         sw_init_logs(main_LogInfo->logfp, &local_LogInfo);
+        local_LogInfo.printProgressMsg = main_LogInfo->printProgressMsg;
+
 
         /* Check if suid needs to be simulated */
         SW_DOM_calc_ncSuid(SW_Domain, suid, ncSuid);

src/SW_Domain.c

@@ -320,6 +320,12 @@ void SW_DOM_SimSet(SW_DOMAIN* SW_Domain, unsigned long userSUID,
         *startSimSet = userSUID - 1;
         *endSimSet = userSUID;
     } else {
+        #if defined(SOILWAT)
+        if(LogInfo->printProgressMsg) {
+            sw_message("is identifying the simulation set ...");
+        }
+        #endif
+
         *endSimSet = SW_Domain->nSUIDs;
         for(*startSimSet = 0; *startSimSet < *endSimSet; (*startSimSet)++) {
             SW_DOM_calc_ncSuid(SW_Domain, *startSimSet, startSuid);

src/SW_Main.c

@@ -80,10 +80,13 @@ int main(int argc, char **argv) {
         goto finishProgram;
     }
 
-	// Print version if not in quiet mode
-	if (!LogInfo.QuietMode) {
-		sw_print_version();
-	}
+    // SOILWAT2: do print progress to console unless user requests quiet
+    LogInfo.printProgressMsg = (Bool)(!LogInfo.QuietMode);
+
+    if (LogInfo.printProgressMsg) {
+      sw_message("started.");
+      sw_print_version();
+    }
 
     // setup and construct domain
     SW_CTL_setup_domain(userSUID, &SW_Domain, &LogInfo);
@@ -162,6 +165,9 @@ int main(int argc, char **argv) {
         SW_WT_ReportTime(SW_WallTime, &LogInfo);
         sw_wrapup_logs(&LogInfo);
         sw_fail_on_error(&LogInfo);
+        if (LogInfo.printProgressMsg) {
+          sw_message("ended.");
+        }
     }
 
 	return 0;

src/SW_Main_lib.c

@@ -261,6 +261,9 @@ void sw_fail_on_error(LOG_INFO* LogInfo) {
         if(!LogInfo->QuietMode) {
             fprintf(stderr, "%s", LogInfo->errorMsg);
         }
+        if(LogInfo->printProgressMsg) {
+            sw_message("ended.");
+        }
         exit(EXIT_FAILURE);
     }
     #endif
@@ -280,6 +283,7 @@ void sw_init_logs(FILE* logInitPtr, LOG_INFO* LogInfo) {
 
 	LogInfo->stopRun = swFALSE;
 	LogInfo->QuietMode = swFALSE;
+	LogInfo->printProgressMsg = swFALSE;
 	LogInfo->numWarnings = 0;
 	LogInfo->numDomainWarnings = 0;
 	LogInfo->numDomainErrors = 0;

src/SW_Output_outtext.c

@@ -335,6 +335,12 @@ void SW_OUT_create_files(SW_FILE_STATUS* SW_FileStatus, SW_OUTPUT* SW_Output,
 
 	OutPeriod pd;
 
+  #if defined(SOILWAT)
+  if(LogInfo->printProgressMsg) {
+      sw_message("is creating output files ...");
+  }
+  #endif
+
 	ForEachOutPeriod(pd) {
 		if (GenOutput->use_OutPeriod[pd]) {
 			_create_csv_files(SW_FileStatus, pd, InFiles, LogInfo);

src/SW_netCDF.c

@@ -1853,6 +1853,12 @@ void SW_NC_create_domain_template(SW_DOMAIN* SW_Domain, LOG_INFO* LogInfo) {
         return; // Exit prematurely due to error
     }
 
+    #if defined(SOILWAT)
+    if(LogInfo->printProgressMsg) {
+        sw_message("is creating a domain template ...");
+    }
+    #endif
+
     if(nc_create(DOMAIN_TEMP, NC_NETCDF4, domFileID) != NC_NOERR) {
         LogError(LogInfo, LOGERROR, "Could not create new domain template due "
                                     "to something internal.");
@@ -2024,6 +2030,11 @@ void SW_NC_create_progress(SW_DOMAIN* SW_Domain, LOG_INFO* LogInfo) {
             create_full_var(progFileID, NC_BYTE, 0, 0, progVarName,
                             attNames, attVals, numAtts, LogInfo);
         } else {
+            #if defined(SOILWAT)
+            if(LogInfo->printProgressMsg) {
+                sw_message("is creating a progress tracker ...");
+            }
+            #endif
             SW_NC_create_template(domFileName, domFileID, progFileName,
                 progFileID, NC_BYTE, 0, 0, progVarName, attNames, attVals,
                 numAtts, swFALSE, freq, LogInfo);

src/filefuncs.c

@@ -15,6 +15,7 @@
 
 #include "include/filefuncs.h"
 #include "include/myMemory.h"
+#include "include/Times.h"
 
 
 /* 01/05/2011	(drs) removed unused variable *p from MkDir()
@@ -207,6 +208,23 @@ void LogError(LOG_INFO* LogInfo, const int mode, const char *fmt, ...) {
 }
 
 
+
+
+/**
+  @brief Print a SOILWAT2 status message
+
+  @param[in] msg Message string.
+*/
+void sw_message(const char *msg) {
+    char timeString[21];
+    timeStringISO8601(timeString, sizeof timeString);
+
+    swprintf("SOILWAT2 (%s) %s\n", timeString, msg);
+}
+
+
+
+
 /**************************************************************/
 Bool GetALine(FILE *f, char buf[], int numChars) {
 	/* Read a line of possibly commented input from the file *f.