InertialEdges.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_INERTIAL_EDGES_HPP
#define OPENSWMM_ENGINE_2D_INERTIAL_EDGES_HPP
 
#include <cstdint>
#include <vector>
 
namespace openswmm::twoD {
 
struct MeshData;

struct InertialEdges {
    int ne = 0; 
 
    // Per-edge arrays (size ne), oriented cL→cR (cL = min(t,nbr), cR = max).
    std::vector<int> cL, cR;        
    std::vector<double> xi;         
    std::vector<double> conveyance; 
    std::vector<double> inv_dx;     
    std::vector<double> zface; 
    std::vector<double> ze_lo, ze_hi;
    std::vector<int> slotL, slotR; 
 
    // Explicit-marcher extension (ExplicitInertialSolver). Precomputed here so
    // the per-substep kernels stay pure arithmetic.
    std::vector<double> nx, ny; 
    std::vector<double> mx, my; 
    std::vector<double> inv_dx_normal;
    std::vector<double> n2_face; 
    std::vector<double> n_face;  
    std::vector<double> cell_lchar;
    std::vector<double> cell_lpos;
 
    // Per-cell CSR incidence for the conservative continuity gather. For cell i,
    // the incident edges are cell_edge[cell_ptr[i] .. cell_ptr[i+1]) with sign
    // cell_sign (+1 if i==cL, −1 if i==cR). Then
    //   dV_i/dt (flux part) = − Σ cell_sign · q[edge] · ψ[edge] · ξ[edge].
    std::vector<int> cell_ptr;  
    std::vector<int> cell_edge; 
    std::vector<int8_t> cell_sign;
    std::vector<double> cell_arm_x, cell_arm_y;

    void build(const MeshData& mesh);

    bool refreshConveyance(const MeshData& mesh);

    bool empty() const noexcept { return ne == 0; }
};
 
} // namespace openswmm::twoD
 
#endif // OPENSWMM_ENGINE_2D_INERTIAL_EDGES_HPP