MsgFileWriter.C

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/>.
 */
 
#include "MsgFileWriter.H"
 
#include <fstream>
 
#include <fmt/core.h>
 
#include "Display.H"
#include "OutputFileCommon.H"
#include "Version.H"
 
bool MsgFileWriter::write(
    const std::string& jobName,
    const std::string& solverName,
    const std::vector<std::pair<int, double>>& iterationHistory,
    double tolerance,
    bool converged
) const {
    std::string msgFile = jobName + ".msg";
    std::ofstream out(msgFile);
    if (!out.is_open()) return false;
 
    out << Display::fileBanner();
 
    out << fmt::format("\n   deltaFlow v{:<32s}Date {:>14s}   Time {:>8s}\n",
        deltaFlow_VERSION, OutputFileCommon::dateStr(), OutputFileCommon::timeStr());
    out << "\n";
 
    out << Display::sectionHeader("I T E R A T I O N   H I S T O R Y");
 
    out << fmt::format("   {:>6s}  {:>16s}  {:>12s}  {:>8s}\n",
        "Iter", "Max Mismatch", "Tolerance", "Status");
    out << "   " << std::string(Display::pageWidth - 4, '-') << "\n";
 
    for (const auto& [iter, error] : iterationHistory) {
        std::string status = (error < tolerance) ? "CONV" : "";
        out << fmt::format("   {:>6d}  {:>16.6e}  {:>12.6e}  {:>8s}\n",
            iter, error, tolerance, status);
    }
 
    out << "   " << std::string(Display::pageWidth - 4, '-') << "\n";
    out << "\n";
 
    if (converged) {
        out << "   " << solverName << " CONVERGED\n";
    } else {
        out << "   *** WARNING: " << solverName << " DID NOT CONVERGE\n";
    }
 
    out << "\n";
    out.close();
    return true;
}