deltaFlow
StaFileWriter.H
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024 Saud Zahir
3 *
4 * This file is part of deltaFlow.
5 *
6 * deltaFlow is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
10 *
11 * deltaFlow is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public
17 * License along with deltaFlow. If not, see
18 * <https://www.gnu.org/licenses/>.
19 */
20
29#ifndef STA_FILE_WRITER_H
30#define STA_FILE_WRITER_H
31
32#include <string>
33
38class StaFileWriter final {
39 public:
55 bool write(
56 const std::string& jobName,
57 const std::string& inputFile,
58 const std::string& solverName,
59 const std::string& formatName,
60 int nBus,
61 int nBranch,
62 int iterations,
63 double finalError,
64 double tolerance,
65 bool converged,
66 double elapsedSec
67 ) const;
68};
69
70#endif
Writes the status file (.sta) with a compact solver summary.
bool write(const std::string &jobName, const std::string &inputFile, const std::string &solverName, const std::string &formatName, int nBus, int nBranch, int iterations, double finalError, double tolerance, bool converged, double elapsedSec) const
Writes the status file (.sta) with a compact solver summary.