openswmm_massbalance.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_MASSBALANCE_H
#define OPENSWMM_MASSBALANCE_H
 
#include "openswmm_engine.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =========================================================================
 * Continuity error queries (valid after SWMM_STATE_ENDED, or during RUNNING)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_get_runoff_continuity_error (SWMM_Engine engine, double* error);
 
SWMM_ENGINE_API int swmm_get_routing_continuity_error(SWMM_Engine engine, double* error);
 
SWMM_ENGINE_API int swmm_get_quality_continuity_error(SWMM_Engine engine,
                                                       int pollutant_idx, double* error);
 
/* =========================================================================
 * Cumulative flux totals (populated during simulation)
 * ========================================================================= */
 
typedef enum SWMM_RunoffTotal {
    SWMM_RUNOFF_RAINFALL   = 0, 
    SWMM_RUNOFF_EVAP       = 1, 
    SWMM_RUNOFF_INFIL      = 2, 
    SWMM_RUNOFF_RUNOFF     = 3, 
    SWMM_RUNOFF_SNOWREMOV  = 4, 
    SWMM_RUNOFF_INITSTORE  = 5, 
    SWMM_RUNOFF_FINALSTORE = 6  
} SWMM_RunoffTotal;
 
typedef enum SWMM_RoutingTotal {
    SWMM_ROUTING_DRY_WEATHER   = 0,  
    SWMM_ROUTING_WET_WEATHER   = 1,  
    SWMM_ROUTING_GW_INFLOW     = 2,  
    SWMM_ROUTING_RDII          = 3,  
    SWMM_ROUTING_EXTERNAL      = 4,  
    SWMM_ROUTING_FLOODING      = 5,  
    SWMM_ROUTING_OUTFLOW       = 6,  
    SWMM_ROUTING_EVAP_LOSS     = 7,  
    SWMM_ROUTING_SEEP_LOSS     = 8,  
    SWMM_ROUTING_INIT_STORAGE  = 9,  
    SWMM_ROUTING_FINAL_STORAGE = 10, 
    SWMM_ROUTING_FORCING_INFLOW = 11 
} SWMM_RoutingTotal;
 
SWMM_ENGINE_API int swmm_get_runoff_total (SWMM_Engine engine, int component, double* volume);
 
SWMM_ENGINE_API int swmm_get_routing_total(SWMM_Engine engine, int component, double* volume);
 
/* =========================================================================
 * Routing diagnostics (combined stats in one call)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_get_routing_stats(SWMM_Engine engine,
    double* avg_step, double* min_step, double* max_step,
    int* n_steps, double* pct_non_converged,
    double* avg_iterations, double* max_courant);
 
SWMM_ENGINE_API int swmm_get_max_courant(SWMM_Engine engine, double* max_courant);
 
/* =========================================================================
 * Quality mass losses (per-pollutant)
 * ========================================================================= */
 
SWMM_ENGINE_API int swmm_get_quality_seep_loss(SWMM_Engine engine, int pollutant_idx, double* mass);
 
SWMM_ENGINE_API int swmm_get_quality_evap_loss(SWMM_Engine engine, int pollutant_idx, double* mass);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* OPENSWMM_MASSBALANCE_H */