report.c File Reference

Legacy simulation report generation and diagnostics. More...

#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <time.h>
#include "headers.h"

Include dependency graph for report.c:

Macros
#define	_CRT_SECURE_NO_DEPRECATE
#define	WRITE(x)
#define	LINE_10   "----------"
#define	LINE_12   "------------"
#define	LINE_51   "---------------------------------------------------"
#define	LINE_64   "----------------------------------------------------------------"
#define	REAL4   float

Functions
int	report_readOptions (char *tok[], int ntoks)
	Reads reporting options from a line of input.
void	report_writeLine (const char *line)
	Writes line of text to report file.
void	report_writeSysTime (void)
	Writes starting/ending processing times to report file.
void	report_writeLogo ()
	Writes report header lines to report file.
void	report_writeTitle ()
	Writes project title to report file.
void	report_writeOptions ()
	Writes analysis options in use to report file.
void	report_writeRainStats (int i, TRainStats *r)
	Writes summary of rain data read from file to report file.
void	report_writeRdiiStats (double rainVol, double rdiiVol)
	Writes summary of RDII inflow to report file.
void	report_writeControlActionsHeading ()
	Write the control-actions section heading to the report stream.
void	report_writeControlAction (DateTime aDate, char *linkID, double value, char *ruleID)
	Reports action taken by a control rule.
void	report_writeRunoffError (TRunoffTotals *totals, double totalArea)
	Writes runoff continuity error to report file.
void	report_writeLoadingError (TLoadingTotals *totals)
	Write runoff-quality continuity tables in groups of up to five pollutants.
void	report_writeGwaterError (TGwaterTotals *totals, double gwArea)
	Writes groundwater continuity error to report file.
void	report_writeFlowError (TRoutingTotals *totals)
	Writes flow routing continuity error to report file.
void	report_writeQualError (TRoutingTotals *QualTotals)
	Write routing-quality continuity tables for all pollutants.
void	report_writeMaxStats (TMaxStats maxMassBalErrs[], TMaxStats maxCourantCrit[], int nMaxStats)
	Report highest continuity errors and Courant-critical network elements.
void	report_writeMaxFlowTurns (TMaxStats flowTurns[], int nMaxStats)
	Lists links with highest number of flow turns (i.e., fraction of time periods where the flow is higher (or lower) than the flows in the previous and following periods).
void	report_writeNonconvergedStats (TMaxStats maxNonconverged[], int nMaxStats)
	Report the most frequently unconverged nodes in a dynamic-wave network.
void	report_writeTimeStepStats (TTimeStepStats *timeStepStats)
	Writes routing time step statistics to report file.
void	report_writeReport ()
	Writes simulation results to report file.
void	report_writeErrorMsg (int code, char *s)
	Writes error message to report file.
void	report_writeErrorCode ()
	Writes error message to report file.
void	report_writeInputErrorMsg (int k, int sect, char *line, long lineCount)
	Writes input error message to report file.
void	report_invokeWarningCallback (const char *msg)
	Forwards a warning to the registered callback, if any. Leading whitespace/newlines are skipped so hosts get a clean log line.
void	report_writeWarningMsg (char *msg, char *id)
	Writes a warning message to the report file.
void	report_writeTseriesErrorMsg (int code, TTable *tseries)
	Report a time-series error with sequence date/time when applicable.

Variables
REAL4 *	SubcatchResults
REAL4 *	NodeResults
REAL4 *	LinkResults
char	ErrString [81]
TNodeStats *	NodeStats

Detailed Description

Legacy simulation report generation and diagnostics.

Author

Caleb Buahin caleb.nosp@m..bua.nosp@m.hin@g.nosp@m.mail.nosp@m..com (OpenSWMM maintenance and extensions)

Copyright

Copyright (c) 2026 Caleb Buahin. OpenSWMM contributions only; original EPA SWMM credits are retained.

License

Apache-2.0 for OpenSWMM contributions; original EPA SWMM provenance is retained.

Macro Definition Documentation

_CRT_SECURE_NO_DEPRECATE

#define _CRT_SECURE_NO_DEPRECATE

LINE_10

#define LINE_10   "----------"

LINE_12

#define LINE_12   "------------"

LINE_51

#define LINE_51   "---------------------------------------------------"

LINE_64

#define LINE_64   "----------------------------------------------------------------"

REAL4

#define REAL4   float

WRITE

#define WRITE

(

x

)

Value:

(report_writeLine((x)))

Variable Documentation

ErrString

char ErrString[81]

extern

LinkResults

REAL4* LinkResults

extern

NodeResults

REAL4* NodeResults

extern

NodeStats

TNodeStats* NodeStats

extern

SubcatchResults

REAL4* SubcatchResults

extern