Detailed Description

Copyright: Copyright (c) 2012-2025, OpenGeoSys Community (http://www.opengeosys.org) Distributed under a Modified BSD License. See accompanying file LICENSE.txt or http://www.opengeosys.org/project/license

#include <tclap/CmdLine.h>
#include "Applications/FileIO/SWMM/SWMMInterface.h"
#include "BaseLib/FileTools.h"
#include "BaseLib/Logging.h"
#include "BaseLib/MPI.h"
#include "BaseLib/StringTools.h"
#include "BaseLib/TCLAPArguments.h"
#include "GeoLib/GEOObjects.h"
#include "GeoLib/IO/XmlIO/Boost/BoostXmlGmlInterface.h"
#include "InfoLib/GitInfo.h"
#include "MeshLib/IO/VtkIO/VtuInterface.h"
#include "MeshLib/Mesh.h"
#include "MeshLib/Properties.h"

Include dependency graph for SWMMConverter.cpp:

Go to the source code of this file.

Functions
int	writeGeoOutput (std::string input_file, std::string output_file)

int	addObjectsToMesh (FileIO::SwmmInterface &swmm, MeshLib::Mesh &mesh, FileIO::SwmmObject const type, std::size_t const timestep)

int	writeMeshOutput (std::string const &input_file, std::string const &output_file, bool const node_args, bool const link_args)

void	writeObjectsOfSwmmTypeToCsv (FileIO::SwmmInterface &swmm, FileIO::SwmmObject const type, std::string const &base, std::string const &ext)

int	writeCsvOutput (std::string input_file, std::string output_file, bool const node_args, bool const link_args, bool const catchment_args, bool const system_args)

int	main (int argc, char *argv[])

Function Documentation

◆ addObjectsToMesh()

int addObjectsToMesh	(	FileIO::SwmmInterface &	swmm,
		MeshLib::Mesh &	mesh,
		FileIO::SwmmObject const	type,
		std::size_t const	timestep )

Definition at line 38 of file SWMMConverter.cpp.

{
    std::size_t const n_node_params(swmm.getNumberOfParameters(type));
    for (std::size_t j = 0; j < n_node_params; ++j)
    {
        std::string const vec_name(swmm.getArrayName(type, j));
        if (vec_name.empty())
            return -2;
        std::vector<double> data_vec =
            swmm.getArrayAtTimeStep(type, timestep, j);
        if (!swmm.addResultsToMesh(mesh, type, vec_name, data_vec))
            return -3;
    }
    return 0;
}

References FileIO::SwmmInterface::addResultsToMesh(), FileIO::SwmmInterface::getArrayAtTimeStep(), FileIO::SwmmInterface::getArrayName(), and FileIO::SwmmInterface::getNumberOfParameters().

Referenced by writeMeshOutput().

◆ main()

int main	(	int	argc,
		char *	argv[] )

Definition at line 162 of file SWMMConverter.cpp.

{
    TCLAP::CmdLine cmd(
        "Read files for the Storm Water Management Model (SWMM) and converts "
        "them into OGS data structures.\n\n"
        "OpenGeoSys-6 software, version " +
            GitInfoLib::GitInfo::ogs_version +
            ".\n"
            "Copyright (c) 2012-2025, OpenGeoSys Community "
            "(http://www.opengeosys.org)",
        ' ', GitInfoLib::GitInfo::ogs_version);
    TCLAP::ValueArg<std::string> mesh_output_arg(
        "m", "mesh", "Output (.vtu). Mesh output file ", false, "",
        "OUTPUT_FILE");
    cmd.add(mesh_output_arg);
    TCLAP::ValueArg<std::string> geo_output_arg(
        "g", "geo", "Output (.gml). Geometry output file ", false, "",
        "OUTPUT_FILE");
    cmd.add(geo_output_arg);
    TCLAP::ValueArg<std::string> csv_output_arg(
        "c", "csv", "Output (.csv). csv output file", false, "", "OUTPUT_FILE");
    cmd.add(csv_output_arg);
    auto log_level_arg = BaseLib::makeLogLevelArg();
    cmd.add(log_level_arg);
    TCLAP::ValueArg<std::string> swmm_input_arg(
        "i", "input", "Input (.inp). SWMM input file", true, "", "INPUT_FILE");
    cmd.add(swmm_input_arg);
    TCLAP::SwitchArg add_nodes_arg(
        "", "node_vars", "Read node variables and add to output mesh");
    cmd.add(add_nodes_arg);
    TCLAP::SwitchArg add_links_arg(
        "", "link_vars", "Read link variables and add to output mesh");
    cmd.add(add_links_arg);
    TCLAP::SwitchArg add_subcatchments_arg(
        "", "subcatchment_vars",
        "Read subcatchment variables and write to CSV-file");
    cmd.add(add_subcatchments_arg);
    TCLAP::SwitchArg add_system_arg(
        "", "system_vars", "Read system variables and write to CSV-file");
    cmd.add(add_system_arg);
    cmd.parse(argc, argv);
 
    BaseLib::MPI::Setup mpi_setup(argc, argv);
    BaseLib::initOGSLogger(log_level_arg.getValue());
 
    if (!(geo_output_arg.isSet() || mesh_output_arg.isSet() ||
          csv_output_arg.isSet()))
    {
        ERR("No output format given. Please specify OGS geometry or mesh "
            "output file.");
        return -1;
    }
 
    if ((add_subcatchments_arg.getValue() || add_system_arg.getValue()) &&
        !csv_output_arg.isSet())
    {
        ERR("Please specify csv output file for exporting subcatchment or "
            "system parameters.");
        return -1;
    }
 
    if (geo_output_arg.isSet())
        writeGeoOutput(swmm_input_arg.getValue(), geo_output_arg.getValue());
 
    if (mesh_output_arg.isSet())
        writeMeshOutput(swmm_input_arg.getValue(), mesh_output_arg.getValue(),
                        add_nodes_arg.getValue(), add_links_arg.getValue());
 
    if (csv_output_arg.isSet())
        writeCsvOutput(swmm_input_arg.getValue(),
                       csv_output_arg.getValue(),
                       add_nodes_arg.getValue(),
                       add_links_arg.getValue(),
                       add_subcatchments_arg.getValue(),
                       add_system_arg.getValue());
 
    return 0;
}

References ERR(), BaseLib::initOGSLogger(), BaseLib::makeLogLevelArg(), GitInfoLib::GitInfo::ogs_version, writeCsvOutput(), writeGeoOutput(), and writeMeshOutput().

◆ writeCsvOutput()

int writeCsvOutput	(	std::string	input_file,
		std::string	output_file,
		bool const	node_args,
		bool const	link_args,
		bool const	catchment_args,
		bool const	system_args )

Definition at line 114 of file SWMMConverter.cpp.

{
    std::unique_ptr<FileIO::SwmmInterface> swmm =
        FileIO::SwmmInterface::create(input_file);
    if (swmm == nullptr)
        return -1;
 
    if (!swmm->existsSwmmOutputFile())
    {
        INFO("No output file found, skipping data conversion to CSV.");
        return -1;
    }
 
    if (!(node_args || link_args || catchment_args || system_args))
    {
        INFO("No data category selected. Nothing to write.");
        return 0;
    }
 
    std::string const basename = BaseLib::dropFileExtension(output_file);
    std::string const extension = BaseLib::getFileExtension(output_file);
 
    if (node_args)
        writeObjectsOfSwmmTypeToCsv(*swmm, FileIO::SwmmObject::NODE, basename,
                                    extension);
 
    if (link_args)
        writeObjectsOfSwmmTypeToCsv(*swmm, FileIO::SwmmObject::LINK, basename,
                                    extension);
 
    if (catchment_args)
        writeObjectsOfSwmmTypeToCsv(*swmm, FileIO::SwmmObject::SUBCATCHMENT,
                                    basename, extension);
 
    if (system_args)
    {
        std::string const obj_file_name =
            std::string(basename + "_system" + extension);
        swmm->writeCsvForObject(obj_file_name, FileIO::SwmmObject::SYSTEM, 0);
    }
    return 0;
}

References FileIO::SwmmInterface::create(), BaseLib::dropFileExtension(), BaseLib::getFileExtension(), INFO(), FileIO::LINK, FileIO::NODE, FileIO::SUBCATCHMENT, FileIO::SYSTEM, and writeObjectsOfSwmmTypeToCsv().

Referenced by main().

◆ writeGeoOutput()

int writeGeoOutput	(	std::string	input_file,
		std::string	output_file )

Definition at line 25 of file SWMMConverter.cpp.

{
    GeoLib::GEOObjects geo_objects;
    if (!FileIO::SwmmInterface::convertSwmmInputToGeometry(input_file,
                                                           geo_objects, true))
        return -1;
 
    GeoLib::IO::BoostXmlGmlInterface xml(geo_objects);
    xml.export_name = BaseLib::extractBaseNameWithoutExtension(input_file);
    BaseLib::IO::writeStringToFile(xml.writeToString(), output_file);
    return 0;
}

References FileIO::SwmmInterface::convertSwmmInputToGeometry(), BaseLib::IO::XMLInterface::export_name, BaseLib::extractBaseNameWithoutExtension(), BaseLib::IO::writeStringToFile(), and BaseLib::IO::Writer::writeToString().

Referenced by main().

◆ writeMeshOutput()

int writeMeshOutput	(	std::string const &	input_file,
		std::string const &	output_file,
		bool const	node_args,
		bool const	link_args )

Definition at line 57 of file SWMMConverter.cpp.

{
    std::unique_ptr<FileIO::SwmmInterface> swmm =
        FileIO::SwmmInterface::create(input_file);
    if (swmm == nullptr)
        return -1;
 
    MeshLib::Mesh& mesh = swmm->getMesh();
 
    bool const no_output_file = !swmm->existsSwmmOutputFile();
    if (!(node_args || link_args) || no_output_file)
    {
        if (no_output_file)
            INFO("No output file found.");
        MeshLib::IO::VtuInterface vtkIO(&mesh, 0, false);
        vtkIO.writeToFile(output_file);
        return 0;
    }
 
    std::string const basename = BaseLib::dropFileExtension(output_file);
    std::string const extension = BaseLib::getFileExtension(output_file);
    std::size_t const n_time_steps(swmm->getNumberOfTimeSteps());
    INFO("Number of simulation time steps: {:d}", n_time_steps);
    for (std::size_t i = 0; i < n_time_steps; i++)
    {
        if (node_args)
            addObjectsToMesh(*swmm, mesh, FileIO::SwmmObject::NODE, i);
 
        if (link_args)
            addObjectsToMesh(*swmm, mesh, FileIO::SwmmObject::LINK, i);
 
        MeshLib::IO::VtuInterface vtkio(&mesh, 0, false);
        std::string name(basename + std::to_string(i) + extension);
        vtkio.writeToFile(name);
    }
    return 0;
}

References addObjectsToMesh(), FileIO::SwmmInterface::create(), BaseLib::dropFileExtension(), BaseLib::getFileExtension(), INFO(), FileIO::LINK, FileIO::NODE, and MeshLib::IO::VtuInterface::writeToFile().

Referenced by main().

◆ writeObjectsOfSwmmTypeToCsv()

void writeObjectsOfSwmmTypeToCsv	(	FileIO::SwmmInterface &	swmm,
		FileIO::SwmmObject const	type,
		std::string const &	base,
		std::string const &	ext )

Definition at line 98 of file SWMMConverter.cpp.

{
    std::size_t n_objects = swmm.getNumberOfObjects(type);
    std::string const& type_str(swmm.swmmObjectTypeToString(type));
    for (std::size_t i = 0; i < n_objects; ++i)
    {
        std::string const obj_name = swmm.getName(type, i);
        std::string const obj_file_name =
            std::string(base + "_" + type_str + "_" + obj_name + ext);
        swmm.writeCsvForObject(obj_file_name, type, i);
    }
}

References FileIO::SwmmInterface::getName(), FileIO::SwmmInterface::getNumberOfObjects(), FileIO::SwmmInterface::swmmObjectTypeToString(), and FileIO::SwmmInterface::writeCsvForObject().

Referenced by writeCsvOutput().

Detailed Description

Functions

Function Documentation

◆ addObjectsToMesh()

◆ main()

◆ writeCsvOutput()

◆ writeGeoOutput()

◆ writeMeshOutput()

◆ writeObjectsOfSwmmTypeToCsv()