SWMMInterface.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
 
#include "GeoLib/Station.h"
 
namespace GeoLib {
    class GEOObjects;
    class Point;
    class Polyline;
}
 
namespace MeshLib {
    class Mesh;
    class Node;
    class Element;
}
 
namespace FileIO
{

enum class SwmmObject
{
    SUBCATCHMENT = 0,
    NODE = 1,
    LINK = 2,
    SYSTEM = 3
};

class SwmmInterface final
{
public:
    static std::unique_ptr<SwmmInterface> create(std::string const& file_name);

    static bool addResultsToMesh(MeshLib::Mesh &mesh, SwmmObject const type,
        std::string const& vec_name, std::vector<double> const& data);

    MeshLib::Mesh& getMesh() const { return *_mesh; }

    std::string getArrayName(SwmmObject obj_type, std::size_t var_idx) const;

    std::vector<std::string> getNames(SwmmObject obj_type) const;

    std::string getName(SwmmObject obj_type, std::size_t idx) const;

    std::size_t getNumberOfObjects(SwmmObject obj_type) const;

    std::size_t getNumberOfParameters(SwmmObject obj_type) const;

    std::size_t getNumberOfTimeSteps() const;

    std::vector<double> getArrayAtTimeStep(SwmmObject obj_type, std::size_t time_step, std::size_t var_idx) const;

    std::vector<double> getArrayForObject(SwmmObject obj_type, std::size_t obj_idx, std::size_t var_idx) const;

    bool getNodeCoordinateVectors(std::vector<double> &x, std::vector<double> &y, std::vector<double> &z) const;

    bool getLinkPointIds(std::vector<std::size_t> &inlets, std::vector<std::size_t> &outlets) const;

    bool writeCsvForTimestep(std::string const& file_name, SwmmObject obj_type, std::size_t time_step) const;

    bool writeCsvForObject(std::string const& file_name, SwmmObject obj_type, std::size_t obj_idx) const;

    static bool isSwmmInputFile(std::string const& inp_file_name);

    bool existsSwmmOutputFile() const;

    static std::string swmmObjectTypeToString(SwmmObject const obj_type);

    static bool convertSwmmInputToGeometry(std::string const& inp_file_name,
        GeoLib::GEOObjects &geo_objects, bool add_subcatchments);

    ~SwmmInterface();
 
private:
    SwmmInterface(std::string const& swmm_base_name);

    bool readSwmmInputToLineMesh();

    template <typename T>
    static bool readCoordinates(std::ifstream &in, std::vector<T*> &points, std::vector<std::string> &names);

    bool readNodeData(std::ifstream &in, std::vector<MeshLib::Node*> &nodes,
        std::map<std::string, std::size_t> const& name_id_map,
        std::vector<double> &max_depth, bool read_max_depth);

    bool readLineElements(std::ifstream &in, std::vector<MeshLib::Element*> &elements,
        std::vector<MeshLib::Node*> const& nodes, std::map<std::string, std::size_t> const& name_id_map);

    bool readSubcatchments(std::ifstream &in, std::map< std::string, std::size_t> const& name_id_map);

    bool readPollutants(std::ifstream &in);

    std::string getArrayName(SwmmObject obj_type, std::size_t var_idx, std::size_t n_pollutants) const;

    bool addRainGaugeTimeSeriesLocations(std::ifstream &in);

    bool matchSubcatchmentsWithPolygons(std::vector<GeoLib::Polyline*> const& lines, std::vector<std::string> const& names);

    std::vector<std::string> getSubcatchmentNameMap() const;

    static bool addPointElevation(std::ifstream &in,
        std::vector<GeoLib::Point*> &points, std::map<std::string,
        std::size_t> const& name_id_map);

    static bool readLinksAsPolylines(std::ifstream &in,
        std::vector<GeoLib::Polyline*> &lines, std::vector<std::string> &line_names,
        std::vector<GeoLib::Point*> const& points, std::map<std::string, std::size_t> const& point_names);

    static bool readPolygons(std::ifstream &in, std::vector<GeoLib::Polyline*> &lines,
        std::vector<std::string> &line_names, std::vector<GeoLib::Point*> &points,
        std::vector<std::string> &pnt_names);

    static bool isSectionFinished(std::string const& str);

    static bool isCommentLine(std::string const& str);

    struct Subcatchment
    {
        std::string name;
        std::size_t rain_gauge;
        std::size_t outlet;
        double area;
        GeoLib::Polyline* outline;
    };
 
    //variables
    std::string const _base_name;
    std::vector<std::string> _id_nodename_map;
    std::vector<std::string> _id_linkname_map;
    std::vector<std::string> _pollutant_names;
    std::vector<Subcatchment> _subcatchments;
    std::vector<GeoLib::Point*> _subcatchment_points;
    std::vector< std::pair<GeoLib::Station, std::string> > _rain_gauges;
    std::unique_ptr<MeshLib::Mesh> _mesh;
};
 
} // namespace FileIO