ArdConfigData.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_DATA_ARD_CONFIG_DATA_HPP
#define OPENSWMM_ENGINE_DATA_ARD_CONFIG_DATA_HPP
 
#include <string>
#include <vector>
 
namespace openswmm {

struct ArdTransportRow {
    std::string element;   
    std::string species;   
    bool        is_ts = false;
    double      value = 0.0;   
    std::string ts_name;       
};

enum class ArdDispersionMode : int {
    OFF     = 0,  
    FISCHER = 1,  
    VALUE   = 2,  
};

struct ArdConfigData {
    bool configured = false;
 
    ArdDispersionMode dispersion_mode = ArdDispersionMode::OFF;

    double dispersion_value = 0.0;
 
    // Per-conduit overrides (parallel arrays, SoA): link index + coefficient
    // in display units. Applied to every cell of the conduit; wins over the
    // global model.
    std::vector<int>    conduit_disp_link;
    std::vector<double> conduit_disp_value;
 
    // ---- E5a: raw boundary/source rows (cold; see ArdTransportRow) -------
    std::vector<ArdTransportRow> boundary_rows;
    std::vector<ArdTransportRow> source_rows;
 
    // ---- E5a: resolved rows (hot; filled by resolveArdTransportRows) -----
    // Boundaries: the node's EXTERNAL INFLOW water carries the MSX species
    // at the given concentration (species units — internal store mass is
    // conc·ft³, so no conversion). Sources: distributed over the conduit's
    // cells, INTERNAL units conc·ft³/s (converted from species-mass/s by
    // dividing by kLitersPerFt3 at resolution).
    std::vector<int>    bc_node;    
    std::vector<int>    bc_msx;     
    std::vector<double> bc_value;   
    std::vector<int>    bc_ts;      
    std::vector<int>    src_link;   
    std::vector<int>    src_msx;
    std::vector<double> src_value;  
    std::vector<int>    src_ts;     
    bool transport_rows_resolved = false;
 
    // ---- E5b ------------------------------------------------------------
    double target_dx = 0.0;
    bool sets_scalar_scheme = false;
    bool sets_limiter = false;

    std::string detailed_output_path;
 
    bool any_dispersion() const noexcept {
        return dispersion_mode != ArdDispersionMode::OFF ||
               !conduit_disp_link.empty();
    }
    bool any_transport_rows() const noexcept {
        return !boundary_rows.empty() || !source_rows.empty();
    }

    bool any_engine_content() const noexcept {
        return any_dispersion() || any_transport_rows() ||
               !detailed_output_path.empty() || target_dx > 0.0;
    }
};

inline constexpr double kLitersPerFt3 = 28.316846592;
 
}  // namespace openswmm
 
#endif  // OPENSWMM_ENGINE_DATA_ARD_CONFIG_DATA_HPP