PollutantData.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_POLLUTANT_DATA_HPP
#define OPENSWMM_ENGINE_POLLUTANT_DATA_HPP
 
#include <vector>
#include <string>
#include <cstdint>
 
namespace openswmm {
 
// ============================================================================
// Concentration units
// ============================================================================

enum class MassUnits : int8_t {
    MG_PER_L  = 0,  
    UG_PER_L  = 1,  
    COUNTS_PER_L = 2 
};
 
// ============================================================================
// PollutantData — pollutant definitions
// ============================================================================

struct PollutantData {
 
    // -----------------------------------------------------------------------
    // Pollutant definition arrays (indexed by pollutant index)
    // -----------------------------------------------------------------------

    std::vector<MassUnits>  units;

    std::vector<double>     mwt;

    std::vector<double>     k_decay;

    std::vector<double>     c_rain;

    std::vector<double>     c_gw;

    std::vector<double>     c_rdii;

    std::vector<double>     c_dwf;

    std::vector<double>     init_conc;

    std::vector<int>        co_pollut;

    std::vector<double>     co_frac;

    std::vector<bool>       snow_only;

    std::vector<std::string> comments;
 
    // -----------------------------------------------------------------------
    // Capacity management
    // -----------------------------------------------------------------------
 
    int n_pollutants() const noexcept { return static_cast<int>(units.size()); }

    void resize_pollutants(int n) {
        const auto un = static_cast<std::size_t>(n);
        units.assign(un, MassUnits::MG_PER_L);
        mwt.assign(un, 1.0);
        k_decay.assign(un, 0.0);
        c_rain.assign(un, 0.0);
        c_gw.assign(un, 0.0);
        c_rdii.assign(un, 0.0);
        c_dwf.assign(un, 0.0);
        init_conc.assign(un, 0.0);
        co_pollut.assign(un, -1);
        co_frac.assign(un, 0.0);
        snow_only.assign(un, false);
        comments.assign(un, std::string{});
    }

    void shrink_to_fit() {
        units.shrink_to_fit();
        mwt.shrink_to_fit();
        k_decay.shrink_to_fit();
        c_rain.shrink_to_fit();
        c_gw.shrink_to_fit();
        c_rdii.shrink_to_fit();
        c_dwf.shrink_to_fit();
        init_conc.shrink_to_fit();
        co_pollut.shrink_to_fit();
        co_frac.shrink_to_fit();
        snow_only.shrink_to_fit();
        comments.shrink_to_fit();
    }
};
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_ENGINE_POLLUTANT_DATA_HPP */