OpenSWMM Engine  6.0.0-alpha.1
Data-oriented, plugin-extensible SWMM Engine (6.0.0-alpha.1)
Loading...
Searching...
No Matches
Treatment.hpp
Go to the documentation of this file.
1
32#ifndef OPENSWMM_TREATMENT_HPP
33#define OPENSWMM_TREATMENT_HPP
34
35#include <string>
36#include <vector>
37
38namespace openswmm {
39
40namespace treatment {
41
42// ============================================================================
43// Expression token types
44// ============================================================================
45
46enum class TokenType : int {
47 NUMBER = 0,
48 VARIABLE = 1,
49 ADD = 2,
50 SUB = 3,
51 MUL = 4,
52 DIV = 5,
53 POW = 6,
54 NEG = 7,
55 FUNC_EXP = 8,
56 FUNC_LOG = 9,
57 FUNC_SQRT = 10,
58 FUNC_MIN = 11,
59 FUNC_MAX = 12,
60 FUNC_ABS = 13,
61 FUNC_SGN = 14,
62 FUNC_STEP = 15,
63 LPAREN = 16,
64 RPAREN = 17,
65 COMMA = 18
66};
67
68enum class TreatVar : int {
69 C = 0,
70 R = 1,
71 DT = 2,
72 HRT = 3,
73 Q = 4,
74 V = 5,
75 D = 6,
76 C_POLLUT = 7,
77 R_POLLUT = 8,
78 AREA = 9
79};
80
81// ============================================================================
82// Expression token
83// ============================================================================
84
91
92// ============================================================================
93// Treatment expression (parsed, ready to evaluate)
94// ============================================================================
95
96struct TreatExpr {
97 std::vector<Token> tokens;
98 int pollutant_idx = -1;
99 bool is_removal = false;
100};
101
102// ============================================================================
103// Functions
104// ============================================================================
105
123int parse(const std::string& expr_str, TreatExpr& result);
124
133int parse(const std::string& expr_str, TreatExpr& result,
134 int (*pollut_lookup)(const std::string& name));
135
148double evaluate(const TreatExpr& expr, double c, double dt,
149 double hrt, double q, double v, double d, double area = 0.0);
150
167double evaluate(const TreatExpr& expr, double c, double dt,
168 double hrt, double q, double v, double d,
169 const double* cin, const double* removal, int n_pollut,
170 double area = 0.0);
171
190double applyTreatment(const TreatExpr& expr, double c_in, double dt,
191 double hrt, double q, double v, double d, double area = 0.0);
192
193} // namespace treatment
194} // namespace openswmm
195
196#endif // OPENSWMM_TREATMENT_HPP
double applyTreatment(const TreatExpr &expr, double c_in, double dt, double hrt, double q, double v, double d, double area)
Apply treatment at a node for one pollutant.
Definition Treatment.cpp:445
TokenType
Definition Treatment.hpp:46
@ LPAREN
Left parenthesis (parser internal, never in output)
@ COMMA
Comma separator for min/max (parser internal)
@ RPAREN
Right parenthesis (parser internal, never in output)
double evaluate(const TreatExpr &expr, double c, double dt, double hrt, double q, double v, double d, double area)
Evaluate a treatment expression with given variable values.
Definition Treatment.cpp:330
TreatVar
Definition Treatment.hpp:68
@ C
Current concentration (this pollutant)
@ R_POLLUT
Removal fraction of another pollutant (uses pollut_ref, co-treatment)
@ C_POLLUT
Concentration of another pollutant (uses pollut_ref)
@ HRT
Hydraulic residence time (hours, per legacy convention)
@ AREA
Node surface area in user units² ((a1+a2)/2*UCF(LENGTH)², matching legacy pvAREA)
@ R
Removal fraction (this pollutant, unused in expressions)
@ Q
Flow rate in user units (Q*UCF(FLOW), matching legacy pvFLOW)
@ D
Depth in user units (y*UCF(LENGTH), matching legacy pvDEPTH)
int parse(const std::string &expr_str, TreatExpr &result)
Parse a treatment expression string into postfix tokens.
Definition Treatment.cpp:275
Definition NodeCoupling.cpp:15
Definition Treatment.hpp:85
double value
For NUMBER tokens.
Definition Treatment.hpp:87
int pollut_ref
Pollutant index for C_POLLUT/R_POLLUT.
Definition Treatment.hpp:89
TokenType type
Definition Treatment.hpp:86
TreatVar var
For VARIABLE tokens.
Definition Treatment.hpp:88
Definition Treatment.hpp:96
bool is_removal
True if expression computes R (removal), false if C.
Definition Treatment.hpp:99
std::vector< Token > tokens
Postfix (RPN) token list.
Definition Treatment.hpp:97
int pollutant_idx
Which pollutant this expression applies to.
Definition Treatment.hpp:98