StaFileWriter.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 "StaFileWriter.H"
 
#include <fstream>
 
#include <fmt/core.h>
 
#include "OutputFileCommon.H"
#include "Version.H"
 
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 {
    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;
}