Node.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_NODE_HPP
#define OPENSWMM_NODE_HPP
 
#include "../core/Constants.hpp"
#include "../data/NodeData.hpp"
#include "../data/TableData.hpp"
 
namespace openswmm {
 
struct SimulationContext;
struct NodeSubtypes;  // relational storage/outfall/divider side-tables (optional source)
 
namespace node {
 
// ============================================================================
// Per-element functions (for C API / single-object queries)
// ============================================================================

double getVolume(const NodeData& nodes, int idx, double depth,
                 TableData* tables = nullptr, int unit_sys = 0,
                 const NodeSubtypes* subs = nullptr);

double getSurfArea(const NodeData& nodes, int idx, double depth,
                   TableData* tables = nullptr, int unit_sys = 0,
                   const NodeSubtypes* subs = nullptr);

double getPondedArea(const NodeData& nodes, int idx, double depth,
                     TableData* tables = nullptr, int unit_sys = 0,
                     const NodeSubtypes* subs = nullptr);

double getMaxOutflow(const NodeData& nodes, int idx, double q, double dt);

double getOverflow(double new_volume, double full_volume, double dt);

double getDepth(const NodeData& nodes, int idx, double volume,
                TableData* tables = nullptr, int unit_sys = 0,
                const NodeSubtypes* subs = nullptr);

inline double getHead(double invert_elev, double depth) {
    return invert_elev + depth;
}
 
// ============================================================================
// Batch functions (for routing hot loop)
// ============================================================================

void computeHeads(const double* invert, const double* depth, double* head, int n);

void computeVolumes(const NodeData& nodes, const double* depth, double* volume,
                    const NodeSubtypes* subs = nullptr);

void computeOverflows(const double* new_volume, const double* full_volume,
                      double* overflow, double dt, int n);
 
} // namespace node
 
// Constants now consolidated in core/Constants.hpp
 
} // namespace openswmm
 
#endif // OPENSWMM_NODE_HPP