QualityData.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_ENGINE_QUALITY_DATA_HPP
#define OPENSWMM_ENGINE_QUALITY_DATA_HPP
 
#include <vector>
#include <string>
#include "../quality/Treatment.hpp"
 
namespace openswmm {
 
// ============================================================================
// Land use definitions
// ============================================================================
 
struct LanduseData {
    int count() const { return static_cast<int>(sweep_interval.size()); }
 
    std::vector<double> sweep_interval; 
    std::vector<double> sweep_removal;  
    std::vector<double> last_swept;     

    std::vector<std::string> comments;

    void resize(int n) {
        auto un = static_cast<std::size_t>(n);
        sweep_interval.assign(un, 0.0);
        sweep_removal.assign(un, 0.0);
        last_swept.assign(un, 0.0);
        comments.assign(un, std::string{});
    }

    void shrink_to_fit() {
        sweep_interval.shrink_to_fit();
        sweep_removal.shrink_to_fit();
        last_swept.shrink_to_fit();
        comments.shrink_to_fit();
    }
};
 
// ============================================================================
// Buildup function per (landuse x pollutant)
// ============================================================================
 
struct BuildupData {
    std::vector<int> func_type; 
    std::vector<double> coeff1;
    std::vector<double> coeff2;
    std::vector<double> coeff3;
    std::vector<int> normalizer; 
 
    int n_landuses = 0;
    int n_pollutants = 0;

    void resize(int nlu, int npoll) {
        n_landuses = nlu;
        n_pollutants = npoll;
        auto total = static_cast<std::size_t>(nlu) * static_cast<std::size_t>(npoll);
        func_type.assign(total, 0);
        coeff1.assign(total, 0.0);
        coeff2.assign(total, 0.0);
        coeff3.assign(total, 0.0);
        normalizer.assign(total, 0);
    }

    void shrink_to_fit() {
        func_type.shrink_to_fit();
        coeff1.shrink_to_fit();
        coeff2.shrink_to_fit();
        coeff3.shrink_to_fit();
        normalizer.shrink_to_fit();
    }
};
 
// ============================================================================
// Washoff function per (landuse x pollutant)
// ============================================================================
 
struct WashoffData {
    std::vector<int> func_type; 
    std::vector<double> coeff;
    std::vector<double> expon;
    std::vector<double> sweep_effic; 
    std::vector<double> bmp_effic;   
 
    int n_landuses = 0;
    int n_pollutants = 0;

    void resize(int nlu, int npoll) {
        n_landuses = nlu;
        n_pollutants = npoll;
        auto total = static_cast<std::size_t>(nlu) * static_cast<std::size_t>(npoll);
        func_type.assign(total, 0);
        coeff.assign(total, 0.0);
        expon.assign(total, 0.0);
        sweep_effic.assign(total, 0.0);
        bmp_effic.assign(total, 0.0);
    }

    void shrink_to_fit() {
        func_type.shrink_to_fit();
        coeff.shrink_to_fit();
        expon.shrink_to_fit();
        sweep_effic.shrink_to_fit();
        bmp_effic.shrink_to_fit();
    }
};
 
// ============================================================================
// Treatment expression per (node x pollutant)
// ============================================================================
 
struct TreatmentData {
    std::vector<std::string> expressions; 
 
    int n_nodes = 0;
    int n_pollutants = 0;

    std::vector<openswmm::treatment::TreatExpr> compiled;

    std::vector<bool> has_treatment;

    std::vector<double> cin;

    std::vector<double> removal;

    void resize(int nn, int npoll) {
        n_nodes = nn;
        n_pollutants = npoll;
        auto total = static_cast<std::size_t>(nn * npoll);
        expressions.assign(total, "");
        compiled.resize(total);
        has_treatment.assign(static_cast<std::size_t>(nn), false);
        cin.assign(static_cast<std::size_t>(npoll), 0.0);
        removal.assign(static_cast<std::size_t>(npoll), -1.0);
    }

    void shrink_to_fit() {
        expressions.shrink_to_fit();
        compiled.shrink_to_fit();
    }

    bool hasAny() const {
        for (const auto& e : expressions)
            if (!e.empty())
                return true;
        return false;
    }
};
 
} // namespace openswmm
 
#endif // OPENSWMM_ENGINE_QUALITY_DATA_HPP