OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
openswmm_inflows.h
Go to the documentation of this file.
1
16#ifndef OPENSWMM_INFLOWS_H
17#define OPENSWMM_INFLOWS_H
18
19#include "openswmm_engine.h"
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25/* =========================================================================
26 * External inflows
27 * ========================================================================= */
28
47SWMM_ENGINE_API int swmm_ext_inflow_add(SWMM_Engine engine, int node_idx, const char* constituent,
48 const char* ts_name, const char* type,
49 double m_factor, double s_factor, double baseline,
50 const char* pattern);
51
52/* =========================================================================
53 * Dry weather flow
54 * ========================================================================= */
55
72SWMM_ENGINE_API int swmm_dwf_add(SWMM_Engine engine, int node_idx, const char* constituent,
73 double avg_value, const char* pat1, const char* pat2,
74 const char* pat3, const char* pat4);
75
76/* =========================================================================
77 * RDII (Rainfall-Dependent Infiltration/Inflow)
78 * ========================================================================= */
79
92SWMM_ENGINE_API int swmm_rdii_add(SWMM_Engine engine, int node_idx, const char* uh_name, double area);
93
94/* =========================================================================
95 * Count queries
96 * ========================================================================= */
97
103SWMM_ENGINE_API int swmm_ext_inflow_count(SWMM_Engine engine);
104
110SWMM_ENGINE_API int swmm_dwf_count(SWMM_Engine engine);
111
117SWMM_ENGINE_API int swmm_rdii_count(SWMM_Engine engine);
118
119#ifdef __cplusplus
120} /* extern "C" */
121#endif
122
123#endif /* OPENSWMM_INFLOWS_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_ext_inflow_count
SWMM_ENGINE_API int swmm_ext_inflow_count(SWMM_Engine engine)
Get the total number of external inflows defined.
Definition openswmm_inflows_impl.cpp:89
swmm_dwf_count
SWMM_ENGINE_API int swmm_dwf_count(SWMM_Engine engine)
Get the total number of dry weather flow entries defined.
Definition openswmm_inflows_impl.cpp:94
swmm_rdii_count
SWMM_ENGINE_API int swmm_rdii_count(SWMM_Engine engine)
Get the total number of RDII entries defined.
Definition openswmm_inflows_impl.cpp:99
swmm_rdii_add
SWMM_ENGINE_API int swmm_rdii_add(SWMM_Engine engine, int node_idx, const char *uh_name, double area)
Add RDII inflow to a node using a unit hydrograph.
Definition openswmm_inflows_impl.cpp:74
swmm_ext_inflow_add
SWMM_ENGINE_API int swmm_ext_inflow_add(SWMM_Engine engine, int node_idx, const char *constituent, const char *ts_name, const char *type, double m_factor, double s_factor, double baseline, const char *pattern)
Add an external inflow to a node.
Definition openswmm_inflows_impl.cpp:22
swmm_dwf_add
SWMM_ENGINE_API int swmm_dwf_add(SWMM_Engine engine, int node_idx, const char *constituent, double avg_value, const char *pat1, const char *pat2, const char *pat3, const char *pat4)
Add a dry weather flow component to a node.
Definition openswmm_inflows_impl.cpp:49