Treatment.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_TREATMENT_HPP
#define OPENSWMM_TREATMENT_HPP
 
#include <string>
#include <vector>
 
namespace openswmm {
 
namespace treatment {
 
// ============================================================================
// Expression token types
// ============================================================================
 
enum class TokenType : int {
    NUMBER = 0,
    VARIABLE = 1,
    ADD = 2,
    SUB = 3,
    MUL = 4,
    DIV = 5,
    POW = 6,
    NEG = 7, 
    FUNC_EXP = 8,
    FUNC_LOG = 9,
    FUNC_SQRT = 10,
    FUNC_MIN = 11,
    FUNC_MAX = 12,
    FUNC_ABS = 13,
    FUNC_SGN = 14,
    FUNC_STEP = 15, 
    LPAREN = 16,    
    RPAREN = 17,    
    COMMA = 18      
};
 
enum class TreatVar : int {
    C = 0,        
    R = 1,        
    DT = 2,       
    HRT = 3,      
    Q = 4,        
    V = 5,        
    D = 6,        
    C_POLLUT = 7, 
    R_POLLUT = 8, 
    AREA = 9 
};
 
// ============================================================================
// Expression token
// ============================================================================
 
struct Token {
    TokenType type = TokenType::NUMBER;
    double value = 0.0;         
    TreatVar var = TreatVar::C; 
    int pollut_ref = -1;        
};
 
// ============================================================================
// Treatment expression (parsed, ready to evaluate)
// ============================================================================
 
struct TreatExpr {
    std::vector<Token> tokens; 
    int pollutant_idx = -1;    
    bool is_removal = false;   
};
 
// ============================================================================
// Functions
// ============================================================================

int parse(const std::string& expr_str, TreatExpr& result);

int parse(const std::string& expr_str, TreatExpr& result,
          int (*pollut_lookup)(const std::string& name));

int validate(const std::string& expr_str, std::string& msg, int& col);

int parse(const std::string& expr_str, TreatExpr& result,
          const std::vector<std::string>& pollut_names);

double evaluate(const TreatExpr& expr, double c, double dt, double hrt, double q, double v,
                double d, double area = 0.0);

double evaluate(const TreatExpr& expr, double c, double dt, double hrt, double q, double v,
                double d, const double* cin, const double* removal, int n_pollut, double area = 0.0,
                const double* cpollut = nullptr);

double applyTreatment(const TreatExpr& expr, double c_in, double dt, double hrt, double q, double v,
                      double d, double area = 0.0);
 
} // namespace treatment
} // namespace openswmm
 
#endif // OPENSWMM_TREATMENT_HPP