1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
// *****************************************************************************
/*!
  \file      src/IO/DiagWriter.cpp
  \copyright 2012-2015 J. Bakosi,
             2016-2018 Los Alamos National Security, LLC.,
             2019-2021 Triad National Security, LLC.,
             2022-2025 J. Bakosi
             All rights reserved. See the LICENSE file for details.
  \brief     Text diagnostics writer declaration
  \details   This file declares the ASCII diagnostics writer class that
     facilitates outputing diagnostics to text files.
*/
// *****************************************************************************

#include <iostream><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <iomanip><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <limits><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.
#include <cstdint><--- Include file:  not found. Please note: Cppcheck does not need standard library headers to get proper results.

#include "DiagWriter.hpp"
#include "Exception.hpp"

using tk::DiagWriter;

DiagWriter::DiagWriter( const std::string& filename,
                        const std::string& format,
                        std::streamsize precision,
                        std::ios_base::openmode mode ) :
  Writer( filename, mode ),
  m_precision( static_cast< int >( precision ) ),
  m_width( std::max( 20, m_precision+8 ) )
// *****************************************************************************
//  Constructor
//! \param[in] filename Output filename to which output the diagnostics
//! \param[in] format Configure floating-point output format ASCII output
//! \param[in] precision Configure precision for floating-point ASCII output
//! \param[in] mode Configure file open mode
// *****************************************************************************
{
  // Set floating-point format for output file stream
  if (format == "default")
    {} //m_outFile << std::defaultfloat;   GCC does not yet support this
  else if (format == "fixed")
    m_outFile << std::fixed;
  else if (format == "scientific")
    m_outFile << std::scientific;
  else Throw( "Text floating-point format not recognized." );

  // Set numeric precision for output file stream if the input makes sense
  if (precision > 0 && precision < std::numeric_limits< tk::real >::digits10+2)
    m_outFile << std::setprecision( static_cast<int>(precision) );
}

void
DiagWriter::header( const std::vector< std::string >& name ) const
// *****************************************************************************
//  Write out diagnostics file header
//! \param[in] name Vector of strings with the names of diagnostics
// *****************************************************************************
{
  m_outFile << "#" << std::setw(9) << "1:it"
            << std::setw(m_width) << "2:t"
            << std::setw(m_width) << "3:dt";
  std::stringstream out;

  // Output names of diagnostics
  std::size_t column = 4;
  for (const auto& n : name) {
    out << column++ << ':' << n;
    m_outFile << std::setw(m_width) << out.str();
    out.str("");
  }

  m_outFile << std::endl;
}

std::size_t
DiagWriter::write( uint64_t it,
                   tk::real t,
                   tk::real dt,
                   const std::vector< tk::real >& diagnostics )
// *****************************************************************************
//  Write out diagnostics
//! \param[in] it Iteration counter
//! \param[in] t Time
//! \param[in] dt Time step size
//! \param[in] diagnostics Vector with the diagnostics
//! \return The total number of diagnostics written to the output file
// *****************************************************************************
{
  m_outFile << std::setw(10) << it
            << std::setw(m_width) << t
            << std::setw(m_width) << dt;

  // Output diagnostics
  for (const auto& d : diagnostics) m_outFile << std::setw(m_width) << d;

  m_outFile << std::endl;

  return diagnostics.size();
}