Transect.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_TRANSECT_HPP
#define OPENSWMM_TRANSECT_HPP
 
#include <vector>
#include <string>
 
#include "XSectLookup.hpp"
 
namespace openswmm {
 
struct TransectStore;  // engine/data/InfraData.hpp
 
namespace transect {
 
constexpr int N_TRANSECT_TBL = 51;
 
struct TransectData {
    std::string name;
    double n_left   = 0.0;   
    double n_right  = 0.0;   
    double n_channel = 0.0;  
    double length_factor = 1.0;  
 
    // Station-elevation pairs
    std::vector<double> stations;    
    std::vector<double> elevations;  
 
    double x_left_bank  = 0.0;  
    double x_right_bank = 0.0;  
 
    // Computed geometry tables (normalized)
    double y_full = 0.0;
    double w_max  = 0.0;
    double a_full = 0.0;
    double r_full = 0.0;
    // CUSTOM shapes only (legacy TShape.sMax/aMax, shape.c getSmax): max
    // section factor and its area for a shape of UNIT height, computed on the
    // unnormalized tables. Scaled by yFull in the caller (xsect.c:685-686).
    double s_max  = 0.0;
    double a_max  = 0.0;
 
    double area_tbl[N_TRANSECT_TBL]  = {};
    double hrad_tbl[N_TRANSECT_TBL]  = {};
    double width_tbl[N_TRANSECT_TBL] = {};

    xsect::LocateLut area_lut;
};

void buildTables(TransectData& td);

void buildCustomTables(TransectData& td, double y_full,
                       const double* curve_x, const double* curve_y, int n_pts);

bool buildFromStore(const TransectStore& ts, int index, double ucf_length,
                    TransectData& td);
 
} // namespace transect
} // namespace openswmm
 
#endif // OPENSWMM_TRANSECT_HPP