VirtualJunctionOps.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_VIRTUAL_JUNCTION_OPS_HPP
#define OPENSWMM_ENGINE_VIRTUAL_JUNCTION_OPS_HPP
 
#include "../core/SimulationContext.hpp"
#include <string>
 
namespace openswmm::edit {

int vj_rule_violation(const SimulationContext& ctx, int node_idx);

void vj_apply_derived_geometry(SimulationContext& ctx, int node_idx);

void vj_clear_virtual(SimulationContext& ctx, int node_idx);

int vj_set_virtual(SimulationContext& ctx, int node_idx, bool make_virtual);

struct SplitResult {
    int new_node_idx = -1;
    int new_link_idx = -1;
    int err = 0; 
};

SplitResult vj_split_conduit(SimulationContext& ctx, int link_idx, double t,
                             const std::string& new_node_name, const std::string& new_link_name,
                             bool make_virtual);

int vj_fuse(SimulationContext& ctx, int node_idx, int* surviving_link_out);
 
// ---------------------------------------------------------------------------
// Inlet junctions — a virtual junction that also carries a street inlet
// (plans/INLET_JUNCTION_IMPLEMENTATION_PLAN_2026-09-05.md §2.6).
// ---------------------------------------------------------------------------

int ij_rule_violation(const SimulationContext& ctx, int node_idx, bool for_drop_inlet);

int ij_host_conduit(const SimulationContext& ctx, int host_kind, int host_idx);

bool ij_usage_shape_ok(const SimulationContext& ctx, int design_idx, int link_idx);

int ij_set_inlet(SimulationContext& ctx, int node_idx, bool make_inlet);

SplitResult ij_split_conduit(SimulationContext& ctx, int link_idx, double t,
                             const std::string& new_node_name, const std::string& new_link_name,
                             int design_idx, int capture_node_idx);

int ij_fuse(SimulationContext& ctx, int node_idx, int* surviving_link_out);
 
} // namespace openswmm::edit
 
#endif /* OPENSWMM_ENGINE_VIRTUAL_JUNCTION_OPS_HPP */