deltaFlow
MsgFileWriter.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 MSG_FILE_WRITER_H
30#define MSG_FILE_WRITER_H
31
32#include <string>
33#include <utility>
34#include <vector>
35
40class MsgFileWriter final {
41 public:
51 bool write(
52 const std::string& jobName,
53 const std::string& solverName,
54 const std::vector<std::pair<int, double>>& iterationHistory,
55 double tolerance,
56 bool converged
57 ) const;
58};
59
60#endif
Writes the message file (.msg) with iteration history.
bool write(const std::string &jobName, const std::string &solverName, const std::vector< std::pair< int, double > > &iterationHistory, double tolerance, bool converged) const
Writes the message file (.msg) with iteration history.