BoundaryData.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_2D_BOUNDARY_DATA_HPP
#define OPENSWMM_ENGINE_2D_BOUNDARY_DATA_HPP
 
#include <vector>
#include <cstdint>
 
namespace openswmm::twoD {

enum class BoundaryType : int8_t {
    WALL            = 0,   
    NORMAL_FLOW     = 1,   
    SPECIFIED_STAGE = 2,   
    SPECIFIED_FLOW  = 3,   
    RATING_CURVE    = 4    
};

struct BoundaryData {

    std::vector<int8_t> edge_bc_type;

    std::vector<double> edge_bed_slope;

    std::vector<double> edge_bc_head;

    std::vector<int> edge_bc_tseries;

    std::vector<std::string> edge_bc_tseries_name;

    std::vector<double> edge_bc_cum_flux;
 
    // -----------------------------------------------------------------------
    // V-E4 — SPECIFIED_FLOW slots (per-metre-of-edge discharge).
    // Sign convention: outward-positive (matches edge_bc_cum_flux).
    // -----------------------------------------------------------------------

    std::vector<double> edge_bc_flow;

    std::vector<int> edge_bc_flow_tseries;

    std::vector<std::string> edge_bc_flow_tseries_name;
 
    // -----------------------------------------------------------------------
    // V-E5 — RATING_CURVE slot (stage → flow lookup).
    // -----------------------------------------------------------------------

    std::vector<int> edge_bc_rating_curve;

    std::vector<std::string> edge_bc_rating_curve_name;
 
    // -----------------------------------------------------------------------
    // Lifecycle
    // -----------------------------------------------------------------------

    void resize(int n_edges) {
        auto n = static_cast<std::size_t>(n_edges);
        edge_bc_type.assign(n, static_cast<int8_t>(BoundaryType::WALL));
        edge_bed_slope.assign(n, 0.0);
        edge_bc_head.assign(n, 0.0);
        edge_bc_tseries.assign(n, -1);
        edge_bc_tseries_name.resize(n);
        edge_bc_cum_flux.assign(n, 0.0);
        edge_bc_flow.assign(n, 0.0);
        edge_bc_flow_tseries.assign(n, -1);
        edge_bc_flow_tseries_name.resize(n);
        edge_bc_rating_curve.assign(n, -1);
        edge_bc_rating_curve_name.resize(n);
    }
 
    int size() const noexcept { return static_cast<int>(edge_bc_type.size()); }
};
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_BOUNDARY_DATA_HPP