StaFileWriter Class Reference

Writes the status file (.sta) with a compact solver summary. More...

#include <StaFileWriter.H>

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

Detailed Description

Writes the status file (.sta) with a compact solver summary.

Definition at line 38 of file StaFileWriter.H.

Member Function Documentation

write()

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

Parameters

jobName	Job name (used as output filename stem).
inputFile	Path to the input data file.
solverName	Name of the solver method used.
formatName	Name of the input file format.
nBus	Number of buses.
nBranch	Number of branches.
iterations	Number of solver iterations performed.
finalError	Final convergence error.
tolerance	Convergence tolerance.
converged	Whether the solver converged.
elapsedSec	Wall-clock time in seconds.

Returns

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

Definition at line 30 of file StaFileWriter.C.

        {
    std::string staFile = jobName + ".sta";
    std::ofstream out(staFile);
    if (!out.is_open()) return false;
 
    out << fmt::format("deltaFlow v{:<36s}Date {:>14s} Time {:>8s}\n",
        deltaFlow_VERSION, OutputFileCommon::dateStr(), OutputFileCommon::timeStr());
 
    out << " SUMMARY OF JOB INFORMATION:\n";
    out << fmt::format(" {:>6s} {:>6s} {:>10s} {:>12s} {:>12s}  {:>8s}\n",
        "ITER", "STATUS", "ERROR", "TOLERANCE", "ELAPSED", "RESULT");
 
    out << fmt::format(" {:>6d} {:>6s} {:>10.3e} {:>12.3e} {:>12.3f}  {:>8s}\n",
        iterations,
        converged ? "CONV" : "FAIL",
        finalError,
        tolerance,
        elapsedSec,
        converged ? "OK" : "FAILED");
 
    out << "\n";
    if (converged) {
        out << " THE ANALYSIS HAS COMPLETED SUCCESSFULLY\n";
    } else {
        out << " THE ANALYSIS HAS FAILED TO CONVERGE\n";
    }
 
    out << "\n";
    out << "Jobinfo File:\n";
    out << fmt::format("Inputfile: {}\n", inputFile);
    out << fmt::format("Solver: {}\n", solverName);
    out << fmt::format("Format: {}\n", formatName);
    out << fmt::format("Hostname: {}\n", OutputFileCommon::hostname());
    out << "\n";
 
    out << "solver and hardware info\n";
    out << "------------------------\n";
    out << fmt::format("version           : {}\n", deltaFlow_VERSION);
    out << fmt::format("compiler          : GCC {}\n", gcc_VERSION);
    out << fmt::format("cmake             : {}\n", CMake_VERSION);
    out << fmt::format("hostname          : {}\n", OutputFileCommon::hostname());
    out << "\n";
 
    out << "model info\n";
    out << "----------\n";
    out << fmt::format(" # of buses       : {}\n", nBus);
    out << fmt::format(" # of branches    : {}\n", nBranch);
    out << "\n";
 
    out << "run and timing info\n";
    out << "-------------------\n";
    out << fmt::format("simulation end    : {}\n", OutputFileCommon::timestamp());
    out << fmt::format("elapsed    time   : {:.3f} seconds\n", elapsedSec);
    out << fmt::format("iterations        : {}\n", iterations);
    out << fmt::format("final error       : {:.6e}\n", finalError);
    out << fmt::format("termination status: {}\n", converged ? "normal" : "failed");
    out << "\n";
 
    out.close();
    return true;
}

References OutputFileCommon::dateStr(), OutputFileCommon::hostname(), OutputFileCommon::timestamp(), 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/StaFileWriter.H
• src/io/StaFileWriter.C