InitialQualityData.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_INITIAL_QUALITY_DATA_HPP
#define OPENSWMM_ENGINE_INITIAL_QUALITY_DATA_HPP
 
#include <vector>
#include <string>
 
namespace openswmm {
 
// ============================================================================
// Per-element initial quality (from [INITIAL_QUALITY] section)
// ============================================================================
 
struct InitialQualityData {
    static constexpr int kKindWaterAge = -1;    
    static constexpr int kKindTemperature = -2; 
    static constexpr int kKindUnresolved = -3;  
    static constexpr int kKindMsxFirst = -100;
    static constexpr int msxKind(int species) noexcept { return kKindMsxFirst - species; }
    static constexpr int msxSpecies(int k) noexcept {
        return (k <= kKindMsxFirst) ? (kKindMsxFirst - k) : -1;
    }

    int count() const { return static_cast<int>(is_link.size()); }
 
    std::vector<uint8_t> is_link;         
    std::vector<std::string> elem_name;   
    std::vector<int> elem_idx;            
    std::vector<std::string> constituent; 
    std::vector<int> kind;                
    std::vector<double> value;            
    std::vector<uint8_t> from_file;

    std::string file;

    void add(bool link, const std::string& name, const std::string& cons, double v, int ei = -1,
             int k = kKindUnresolved, bool fromFile = false) {
        is_link.push_back(link ? 1 : 0);
        elem_name.push_back(name);
        elem_idx.push_back(ei);
        constituent.push_back(cons);
        kind.push_back(k);
        value.push_back(v);
        from_file.push_back(fromFile ? 1 : 0);
    }

    void erase(int idx) {
        if (idx < 0 || idx >= count())
            return;
        const auto u = static_cast<std::size_t>(idx);
        is_link.erase(is_link.begin() + u);
        elem_name.erase(elem_name.begin() + u);
        elem_idx.erase(elem_idx.begin() + u);
        constituent.erase(constituent.begin() + u);
        kind.erase(kind.begin() + u);
        value.erase(value.begin() + u);
        if (u < from_file.size())
            from_file.erase(from_file.begin() + u);
    }
};
 
} // namespace openswmm
 
#endif // OPENSWMM_ENGINE_INITIAL_QUALITY_DATA_HPP