Inflow.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_INFLOW_HPP
#define OPENSWMM_INFLOW_HPP
 
#include <cstdint>
#include <vector>
 
namespace openswmm {
 
struct SimulationContext;
class SWMMEngine;
 
namespace inflow {
 
// ============================================================================
// Pattern types
// ============================================================================
 
constexpr int MONTHLY_PATTERN = 0;
constexpr int DAILY_PATTERN = 1;
constexpr int HOURLY_PATTERN = 2;
constexpr int WEEKEND_PATTERN = 3;
 
// ============================================================================
// Per-node external inflow definition (SoA)
// ============================================================================

enum class ExtInflowKind : int {
    FLOW = 0,   
    CONCEN = 1, 
    MASS = 2,   
    AGE = 3,
    MSX_CONCEN = 4,
    MSX_MASS = 5
};
 
struct ExtInflowSoA {
    int count = 0;
    std::vector<int> node_idx;        
    std::vector<int> ts_idx;          
    std::vector<int> base_pat_idx;    
    std::vector<double> baseline;     
    std::vector<double> scale_factor; 
    std::vector<double> conv_factor;  
    std::vector<int> kind;
    std::vector<int> pollut_idx;

    void resize(int n);
};
 
// ============================================================================
// Per-node dry weather flow definition (SoA)
// ============================================================================
 
struct DwfInflowSoA {
    int count = 0;
    std::vector<int> node_idx;     
    std::vector<double> avg_value; 
    std::vector<int> pat_monthly;  
    std::vector<int> pat_daily;    
    std::vector<int> pat_hourly;   
    std::vector<int> pat_weekend;  
    std::vector<uint8_t> is_flow;
    std::vector<int> pollut_idx;
    std::vector<int> msx_idx;

    void resize(int n);
};
 
// ============================================================================
// Time pattern table (12 monthly, 7 daily, 24 hourly values)
// ============================================================================
 
struct TimePattern {
    int type = 0;            
    double factors[24] = {}; 
};
 
// ============================================================================
// Inflow solver
// ============================================================================

class InflowSolver {
public:
    void init(SimulationContext& ctx);

    void refreshPatterns(const SimulationContext& ctx);

    void computeAll(SimulationContext& ctx, double current_date, double dt);
 
private:
    friend class openswmm::SWMMEngine;
    ExtInflowSoA ext_inflows_;
    DwfInflowSoA dwf_inflows_;
    std::vector<TimePattern> patterns_;

    double getPatternFactor(int pat_idx, int month, int day, int hour) const;
};
 
} // namespace inflow
} // namespace openswmm
 
#endif // OPENSWMM_INFLOW_HPP