OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm_statistics.h
Go to the documentation of this file.
1
16#ifndef OPENSWMM_STATISTICS_H
17#define OPENSWMM_STATISTICS_H
18
19#include "openswmm_engine.h"
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25/* =========================================================================
26 * Node Statistics
27 * ========================================================================= */
28
30SWMM_ENGINE_API int swmm_stat_node_max_depth(SWMM_Engine engine, int idx, double* val);
31
33SWMM_ENGINE_API int swmm_stat_node_max_overflow(SWMM_Engine engine, int idx, double* val);
34
36SWMM_ENGINE_API int swmm_stat_node_vol_flooded(SWMM_Engine engine, int idx, double* val);
37
39SWMM_ENGINE_API int swmm_stat_node_time_flooded(SWMM_Engine engine, int idx, double* val);
40
41/* =========================================================================
42 * Link Statistics
43 * ========================================================================= */
44
46SWMM_ENGINE_API int swmm_stat_link_max_flow(SWMM_Engine engine, int idx, double* val);
47
49SWMM_ENGINE_API int swmm_stat_link_max_velocity(SWMM_Engine engine, int idx, double* val);
50
52SWMM_ENGINE_API int swmm_stat_link_max_filling(SWMM_Engine engine, int idx, double* val);
53
55SWMM_ENGINE_API int swmm_stat_link_vol_flow(SWMM_Engine engine, int idx, double* val);
56
58SWMM_ENGINE_API int swmm_stat_link_surcharge_time(SWMM_Engine engine, int idx, double* val);
59
60/* =========================================================================
61 * Subcatchment Statistics
62 * ========================================================================= */
63
65SWMM_ENGINE_API int swmm_stat_subcatch_precip(SWMM_Engine engine, int idx, double* val);
66
68SWMM_ENGINE_API int swmm_stat_subcatch_runoff_vol(SWMM_Engine engine, int idx, double* val);
69
71SWMM_ENGINE_API int swmm_stat_subcatch_max_runoff(SWMM_Engine engine, int idx, double* val);
72
73/* =========================================================================
74 * Bulk Statistics
75 * ========================================================================= */
76
78SWMM_ENGINE_API int swmm_stat_node_max_depth_bulk(SWMM_Engine engine, double* buf, int count);
79
81SWMM_ENGINE_API int swmm_stat_link_max_flow_bulk(SWMM_Engine engine, double* buf, int count);
82
84SWMM_ENGINE_API int swmm_stat_subcatch_runoff_vol_bulk(SWMM_Engine engine, double* buf, int count);
85
86#ifdef __cplusplus
87} /* extern "C" */
88#endif
89
90#endif /* OPENSWMM_STATISTICS_H */
SWMM_Engine
void * SWMM_Engine
Opaque handle to an OpenSWMM Engine instance.
Definition openswmm_callbacks.h:35
openswmm_engine.h
OpenSWMM Engine — primary transparent C API (master header).
SWMM_ENGINE_API
#define SWMM_ENGINE_API
Definition openswmm_engine.h:87
swmm_stat_link_vol_flow
SWMM_ENGINE_API int swmm_stat_link_vol_flow(SWMM_Engine engine, int idx, double *val)
Total volume conveyed through a link (project volume units).
Definition openswmm_statistics_impl.cpp:82
swmm_stat_link_max_velocity
SWMM_ENGINE_API int swmm_stat_link_max_velocity(SWMM_Engine engine, int idx, double *val)
Maximum velocity in a link (project length/time units).
Definition openswmm_statistics_impl.cpp:66
swmm_stat_subcatch_precip
SWMM_ENGINE_API int swmm_stat_subcatch_precip(SWMM_Engine engine, int idx, double *val)
Total precipitation volume at a subcatchment (project volume units).
Definition openswmm_statistics_impl.cpp:102
swmm_stat_link_surcharge_time
SWMM_ENGINE_API int swmm_stat_link_surcharge_time(SWMM_Engine engine, int idx, double *val)
Total surcharge time for a link (hours).
Definition openswmm_statistics_impl.cpp:90
swmm_stat_node_max_depth_bulk
SWMM_ENGINE_API int swmm_stat_node_max_depth_bulk(SWMM_Engine engine, double *buf, int count)
Get maximum depth for all nodes into a caller-supplied buffer.
Definition openswmm_statistics_impl.cpp:130
swmm_stat_subcatch_runoff_vol_bulk
SWMM_ENGINE_API int swmm_stat_subcatch_runoff_vol_bulk(SWMM_Engine engine, double *buf, int count)
Get total runoff volume for all subcatchments into a caller-supplied buffer.
Definition openswmm_statistics_impl.cpp:150
swmm_stat_link_max_flow
SWMM_ENGINE_API int swmm_stat_link_max_flow(SWMM_Engine engine, int idx, double *val)
Maximum flow in a link (project flow units).
Definition openswmm_statistics_impl.cpp:58
swmm_stat_link_max_flow_bulk
SWMM_ENGINE_API int swmm_stat_link_max_flow_bulk(SWMM_Engine engine, double *buf, int count)
Get maximum flow for all links into a caller-supplied buffer.
Definition openswmm_statistics_impl.cpp:140
swmm_stat_node_max_overflow
SWMM_ENGINE_API int swmm_stat_node_max_overflow(SWMM_Engine engine, int idx, double *val)
Maximum overflow rate at a node (project flow units).
Definition openswmm_statistics_impl.cpp:30
swmm_stat_node_vol_flooded
SWMM_ENGINE_API int swmm_stat_node_vol_flooded(SWMM_Engine engine, int idx, double *val)
Total volume flooded at a node (project volume units).
Definition openswmm_statistics_impl.cpp:38
swmm_stat_subcatch_max_runoff
SWMM_ENGINE_API int swmm_stat_subcatch_max_runoff(SWMM_Engine engine, int idx, double *val)
Maximum runoff rate from a subcatchment (project flow units).
Definition openswmm_statistics_impl.cpp:118
swmm_stat_link_max_filling
SWMM_ENGINE_API int swmm_stat_link_max_filling(SWMM_Engine engine, int idx, double *val)
Maximum depth/full-depth ratio in a link.
Definition openswmm_statistics_impl.cpp:74
swmm_stat_node_time_flooded
SWMM_ENGINE_API int swmm_stat_node_time_flooded(SWMM_Engine engine, int idx, double *val)
Total time flooded at a node (hours).
Definition openswmm_statistics_impl.cpp:46
swmm_stat_node_max_depth
SWMM_ENGINE_API int swmm_stat_node_max_depth(SWMM_Engine engine, int idx, double *val)
Maximum depth at a node (project length units).
Definition openswmm_statistics_impl.cpp:22
swmm_stat_subcatch_runoff_vol
SWMM_ENGINE_API int swmm_stat_subcatch_runoff_vol(SWMM_Engine engine, int idx, double *val)
Total runoff volume from a subcatchment (project volume units).
Definition openswmm_statistics_impl.cpp:110