globals.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//   globals.h
//
//   Project: EPA SWMM5
//   Version: 5.2
//   Date:    11/01/21 (Build 5.2.0)
//   Author:  L. Rossman
//
//   Global Variables
//
//   Update History
//   ==============
//   Build 5.1.004:
//   - Ignore RDII option added.
//   Build 5.1.007:
//   - Monthly climate variable adjustments added.
//   Build 5.1.008:
//   - Number of parallel threads for dynamic wave routing added.
//   - Minimum dynamic wave routing variable time step added.
//   Build 5.1.011:
//   - Changed WarningCode to Warnings (# warnings issued)
//   - Added error message text as a variable.
//   - Added elapsed simulation time (in decimal days) variable.
//   - Added variables associated with detailed routing events.
//   Build 5.1.012:
//   - InSteadyState variable made local to routing_execute in routing.c.
//   Build 5.1.013:
//   - CrownCutoff and RuleStep added as analysis option variables.
//   Build 5.1.015:
//   - Fixes bug in summary statistics when Report Start date > Start Date.
//   Build 5.2.0:
//   - Support for relative file names added.
//   - Support for writing multiple output hotstart files for given times
//   Build 5.3.0:
//   - Implemented option to save multiple hotstart files at different times
//-----------------------------------------------------------------------------

 
#ifndef GLOBALS_H
#define GLOBALS_H
 
EXTERN TFile Finp,     // Input file
    Fout,              // Output file
    Frpt,              // Report file
    Fclimate,          // Climate file
    Frain,             // Rainfall file
    Frunoff,           // Runoff file
    Frdii,             // RDII inflow file
    FhotstartInput,    // Hot start input file
    *FhotstartOutputs, // Hot start output files
    Finflows,          // Inflows routing file
    Foutflows;         // Outflows routing file
 
EXTERN long Nperiods, // Number of reporting periods
    TotalStepCount,   // Total routing steps used
    ReportStepCount,  // Reporting routing steps used
    NonConvergeCount; // Number of non-converging steps
 
EXTERN char Msg[MAXMSG + 1],     // Text of output message
    ErrorMsg[MAXMSG + 1],        // Text of error message
    Title[MAXTITLE][MAXMSG + 1], // Project title
    TempDir[MAXFNAME + 1],       // Temporary file directory
    InpDir[MAXFNAME + 1];        // Input file directory
 
EXTERN TRptFlags RptFlags; // Reporting options
 
EXTERN int Nobjects[MAX_OBJ_TYPES], // Number of each object type
    Nnodes[MAX_NODE_TYPES],         // Number of each node sub-type
    Nlinks[MAX_LINK_TYPES],         // Number of each link sub-type
    UnitSystem,                     // Unit system
    FlowUnits,                      // Flow units
    InfilModel,                     // Infiltration method
    RouteModel,                     // Flow routing method
    ForceMainEqn,                   // Flow equation for force mains
    LinkOffsets,                    // Link offset convention
    SurchargeMethod,                // EXTRAN or SLOT method
    ZeroOutfallBackflowQual,        // Outfall backflow enters clean
    AllowPonding,                   // Allow water to pond at nodes
    InertDamping,                   // Degree of inertial damping
    NormalFlowLtd,                  // Normal flow limited
    SlopeWeighting,                 // Use slope weighting
    Compatibility,                  // SWMM 5/3/4 compatibility
    SkipSteadyState,                // Skip over steady state periods
    IgnoreRainfall,                 // Ignore rainfall/runoff
    IgnoreRDII,                     // Ignore RDII
    IgnoreSnowmelt,                 // Ignore snowmelt
    IgnoreGwater,                   // Ignore groundwater
    IgnoreRouting,                  // Ignore flow routing
    IgnoreQuality,                  // Ignore water quality
    ErrorCode,                      // Error code number
    Warnings,                       // Number of warning messages
    WetStep,                        // Runoff wet time step (sec)
    DryStep,                        // Runoff dry time step (sec)
    ReportStep,                     // Reporting time step (sec)
    RuleStep,                       // Rule evaluation time step (sec)
    SweepStart,                     // Day of year when sweeping starts
    SweepEnd,                       // Day of year when sweeping ends
    MaxTrials,                      // Max. trials for DW routing
    NumThreads,                     // Number of parallel threads used
    NumEvents;                      // Number of detailed events
 
EXTERN double RouteStep, // Routing time step (sec)
    MinRouteStep,        // Minimum variable time step (sec)
    LengtheningStep,     // Time step for lengthening (sec)
    StartDryDays,        // Antecedent dry days
    CourantFactor,       // Courant time step factor
    MinSurfArea,         // Minimum nodal surface area
    MinSlope,            // Minimum conduit slope
    RunoffError,         // Runoff continuity error
    GwaterError,         // Groundwater continuity error
    FlowError,           // Flow routing error
    QualError,           // Quality routing error
    HeadTol,             // DW routing head tolerance (ft)
    SysFlowTol,          // Tolerance for steady system flow
    LatFlowTol,          // Tolerance for steady nodal inflow
    CrownCutoff;         // Fractional pipe crown cutoff
 
EXTERN DateTime StartDate, // Starting date
    StartTime,             // Starting time
    StartDateTime,         // Starting Date+Time
    EndDate,               // Ending date
    EndTime,               // Ending time
    EndDateTime,           // Ending Date+Time
    ReportStartDate,       // Report start date
    ReportStartTime,       // Report start time
    ReportStart;           // Report start Date+Time
 
EXTERN double ReportTime, // Current reporting time (msec)
    OldRunoffTime,        // Previous runoff time (msec)
    NewRunoffTime,        // Current runoff time (msec)
    OldRoutingTime,       // Previous routing time (msec)
    NewRoutingTime,       // Current routing time (msec)
    TotalDuration,        // Simulation duration (msec)
    ElapsedTime;          // Current elapsed time (days)
 
EXTERN TTemp Temp;     // Temperature data
EXTERN TEvap Evap;     // Evaporation data
EXTERN TWind Wind;     // Wind speed data
EXTERN TSnow Snow;     // Snow melt data
EXTERN TAdjust Adjust; // Climate adjustments
 
EXTERN TSnowmelt* Snowmelt; // Array of snow melt objects
EXTERN TGage* Gage;         // Array of rain gages
EXTERN TSubcatch* Subcatch; // Array of subcatchments
EXTERN TAquifer* Aquifer;   // Array of groundwater aquifers
EXTERN TUnitHyd* UnitHyd;   // Array of unit hydrographs
EXTERN TNode* Node;         // Array of nodes
EXTERN TOutfall* Outfall;   // Array of outfall nodes
EXTERN TDivider* Divider;   // Array of divider nodes
EXTERN TStorage* Storage;   // Array of storage nodes
EXTERN TLink* Link;         // Array of links
EXTERN TConduit* Conduit;   // Array of conduit links
EXTERN TPump* Pump;         // Array of pump links
EXTERN TOrifice* Orifice;   // Array of orifice links
EXTERN TWeir* Weir;         // Array of weir links
EXTERN TOutlet* Outlet;     // Array of outlet device links
EXTERN TPollut* Pollut;     // Array of pollutants
EXTERN TLanduse* Landuse;   // Array of landuses
EXTERN TPattern* Pattern;   // Array of time patterns
EXTERN TTable* Curve;       // Array of curve tables
EXTERN TTable* Tseries;     // Array of time series tables
EXTERN TTransect* Transect; // Array of transect data
EXTERN TStreet* Street;     // Array of defined Street cross-sections
EXTERN TShape* Shape;       // Array of custom conduit shapes
EXTERN TEvent* Event;       // Array of routing events
 
// Process-global warning callback. When set (via swmm_setWarningCallback), the
// engine invokes it for each warning in addition to writing the .rpt line, so a
// host can stream warnings live. Raw function-pointer type (not the public
// typedef) to avoid include-order coupling; the types are compatible.
EXTERN void (*WarningCallback)(const char* message, void* userData);
EXTERN void* WarningCallbackData; // Opaque user data for the callback
 
#endif //GLOBALS_H