InterfaceFile.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_INTERFACE_FILE_HPP
#define OPENSWMM_INTERFACE_FILE_HPP
 
#include <vector>
#include <string>
#include <cstdio>
 
namespace openswmm {
 
struct SimulationContext;
 
namespace iface {
 
// ============================================================================
// SoA for interface node data (flows + quality per node)
// ============================================================================
 
struct InterfaceFileSoA {
    int count = 0;
    std::vector<int>    node_idx;       
    std::vector<double> old_values;     
    std::vector<double> new_values;     
 
    void resize(int n);
};
 
// ============================================================================
// InterfaceManager — manages reading/writing of routing interface files
// ============================================================================
 
class InterfaceManager {
public:
    void init(SimulationContext& ctx);

    int openFiles(const std::string& infile_path, const std::string& outfile_path);

    int readFileHeader(SimulationContext& ctx);

    void writeFileHeader(const SimulationContext& ctx);

    void readInflows(SimulationContext& ctx, double current_time);

    void writeOutfallResults(const SimulationContext& ctx, double current_time);

    void closeFiles();

    double getFlow(int node_idx, double frac) const;

    double getQuality(int node_idx, int pollut_idx, double frac) const;

    int getNumIfaceNodes() const { return data_.count; }

    int getIfaceNode(int index) const;

    double getFrac() const { return iface_frac_; }
 
private:
    InterfaceFileSoA data_;
    FILE* infile_  = nullptr;
    FILE* outfile_ = nullptr;
 
    double old_time_ = 0.0;         
    double new_time_ = 0.0;         
    int n_iface_polluts_ = 0;       
    int n_values_per_node_ = 1;     
    int iface_flow_units_ = 0;      
    int iface_step_ = 0;            
    double iface_frac_ = 0.0;       
 
    std::vector<int> pollut_map_;   

    bool readNextPeriod();

    void setOldValues();

    static bool isOutletNode(const SimulationContext& ctx, int node_idx);
};
 
} // namespace iface
} // namespace openswmm
 
#endif // OPENSWMM_INTERFACE_FILE_HPP