SpatialFrame.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_SPATIAL_FRAME_HPP
#define OPENSWMM_ENGINE_SPATIAL_FRAME_HPP
 
#include <string>
#include <vector>
#include <cstdint>
 
namespace openswmm {
 
// ============================================================================
// Forward declarations for 2D coupling (R30)
// ============================================================================

class ICouplingPoint {
public:
    virtual ~ICouplingPoint() = default;

    virtual int object_index() const noexcept = 0;

    virtual const char* object_type() const noexcept = 0;

    virtual void exchange_to_2d(double value) = 0;

    virtual double receive_from_2d() const = 0;
};
 
// ============================================================================
// SpatialFrame
// ============================================================================

struct SpatialFrame {
    // -----------------------------------------------------------------------
    // Coordinate reference system
    // -----------------------------------------------------------------------

    std::string crs;

    bool is_geographic = false;
 
    // -----------------------------------------------------------------------
    // Map extents (from [MAP] DIMENSIONS)
    // -----------------------------------------------------------------------

    double map_x1 = 0.0;

    double map_y1 = 0.0;

    double map_x2 = 0.0;

    double map_y2 = 0.0;

    std::string map_units;
 
    // -----------------------------------------------------------------------
    // Node coordinates (indexed parallel to NodeData)
    // -----------------------------------------------------------------------

    std::vector<double> node_x;

    std::vector<double> node_y;
 
    // -----------------------------------------------------------------------
    // Link coordinates (one point per link — nominal centroid or from-node)
    // -----------------------------------------------------------------------

    std::vector<double> link_x;

    std::vector<double> link_y;
 
    // -----------------------------------------------------------------------
    // Subcatchment centroid coordinates
    // -----------------------------------------------------------------------

    std::vector<double> subcatch_x;

    std::vector<double> subcatch_y;
 
    // -----------------------------------------------------------------------
    // Link vertices (polyline points between from-node and to-node)
    // -----------------------------------------------------------------------

    std::vector<std::vector<double>> link_vertices_x;

    std::vector<std::vector<double>> link_vertices_y;
 
    // -----------------------------------------------------------------------
    // Subcatchment polygon vertices
    // -----------------------------------------------------------------------

    std::vector<std::vector<double>> subcatch_polygon_x;

    std::vector<std::vector<double>> subcatch_polygon_y;
 
    // -----------------------------------------------------------------------
    // Gage coordinates
    // -----------------------------------------------------------------------

    std::vector<double> gage_x;

    std::vector<double> gage_y;
 
    // -----------------------------------------------------------------------
    // 2D coupling interface (R30)
    // -----------------------------------------------------------------------

    std::vector<ICouplingPoint*> coupling_points;

    void register_coupling_point(ICouplingPoint* point) {
        if (point) coupling_points.push_back(point);
    }

    bool has_2d_coupling() const noexcept {
        return !coupling_points.empty();
    }

    void shrink_to_fit() {
        node_x.shrink_to_fit();
        node_y.shrink_to_fit();
        link_x.shrink_to_fit();
        link_y.shrink_to_fit();
        subcatch_x.shrink_to_fit();
        subcatch_y.shrink_to_fit();
        gage_x.shrink_to_fit();
        gage_y.shrink_to_fit();
 
        link_vertices_x.shrink_to_fit();
        for (auto& v : link_vertices_x) v.shrink_to_fit();
        link_vertices_y.shrink_to_fit();
        for (auto& v : link_vertices_y) v.shrink_to_fit();
 
        subcatch_polygon_x.shrink_to_fit();
        for (auto& v : subcatch_polygon_x) v.shrink_to_fit();
        subcatch_polygon_y.shrink_to_fit();
        for (auto& v : subcatch_polygon_y) v.shrink_to_fit();
    }
};
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_ENGINE_SPATIAL_FRAME_HPP */