Link.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_LINK_HPP
#define OPENSWMM_LINK_HPP
 
#include "../data/LinkData.hpp"
#include "XSectBatch.hpp"
#include "Node.hpp"
#include "Transect.hpp"
 
#include <vector>
 
namespace openswmm {
 
namespace link {
 
// ============================================================================
// Per-element functions
// ============================================================================

double getVelocity(const XSectParams& xs, double flow, double depth, int barrels = 1);

double getFroude(const XSectParams& xs, double v, double y);

void computeConveyance(double roughness, double slope, double s_full, double& beta,
                       double& rough_factor, double& q_full);

double getDepthFromFlow(const XSectParams& xs, double beta, double q, double q_max = -1.0);

double getCapacity(const XSectParams& xs, double depth);

double getHydPower(double flow, double head_upstream, double head_downstream);

XSectParams buildXSectParams(const LinkData& links, std::size_t uj,
                             const std::vector<transect::TransectData>* transects = nullptr);
 
// ============================================================================
// Batch functions (for routing hot loop)
// ============================================================================
 
// Phase 6: computeVelocities/computeFroude/computeAllConveyance removed (dead
// code; referenced conduit fields now in ConduitData — see LinkSubtypes.hpp).

int translateShape(XsectShape link_shape);

inline double filledCircularOffsetBump(const LinkData& links, std::size_t j, bool resolved) {
    if (!resolved)
        return 0.0;
    if (links.type[j] != LinkType::CONDUIT || links.xsect_shape[j] != XsectShape::FILLED_CIRCULAR)
        return 0.0;
    return links.xsect_y_bot[j];
}

void applyTabulatedXSectParams(XSectParams& xs, const transect::TransectData& td, double y_full,
                               int transect_idx);
 
} // namespace link
 
} // namespace openswmm
 
#endif // OPENSWMM_LINK_HPP