DatFileWriter.H

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Saud Zahir
 *
 * This file is part of deltaFlow.
 *
 * deltaFlow is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * deltaFlow is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with deltaFlow.  If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#ifndef DAT_FILE_WRITER_H
#define DAT_FILE_WRITER_H
 
#include <string>
#include <utility>
#include <vector>
 
#include "Data.H"
 
class DatFileWriter final {
    public:
        bool write(
            const std::string& jobName,
            const std::string& inputFile,
            const std::string& solverName,
            const std::string& formatName,
            const BusData& busData,
            const BranchData& branchData,
            const std::vector<std::pair<int, double>>& iterationHistory,
            int totalIterations,
            double finalError,
            double tolerance,
            bool converged,
            double elapsedSec,
            double basemva = 100.0
        ) const;
};
 
#endif