MsgFileWriter Class Reference

Writes the message file (.msg) with iteration history. More...

#include <MsgFileWriter.H>

Public Member Functions
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.

Detailed Description

Writes the message file (.msg) with iteration history.

Definition at line 40 of file MsgFileWriter.H.

Member Function Documentation

write()

bool MsgFileWriter::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.

Parameters

jobName	Job name (used as output filename stem).
solverName	Name of the solver method used.
iterationHistory	Vector of (iteration, error) pairs.
tolerance	Convergence tolerance.
converged	Whether the solver converged.

Returns

true on success, false if file could not be opened.

Definition at line 31 of file MsgFileWriter.C.

        {
    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;
}

References OutputFileCommon::dateStr(), Display::fileBanner(), Display::pageWidth, Display::sectionHeader(), and OutputFileCommon::timeStr().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• src/io/MsgFileWriter.H
• src/io/MsgFileWriter.C