journal.hpp

Go to the documentation of this file.

#pragma once
#include <deal.II/base/table_handler.h>
 
#include <meltpooldg/utilities/conditional_ostream.hpp>
 
#include <functional>
#include <iomanip>
 
namespace MeltPoolDG::Journal
{
  // maximum character width of terminal text
  static constexpr int max_text_width = 100;
 
  inline void
  print_decoration_line(const ConditionalOStream &pcout)
  {
    pcout << "+" << std::string(max_text_width - 2, '-') << "+" << std::endl;
  }
 
  void
  print_line(const ConditionalOStream &pcout,
             const std::string        &text           = "",
             const std::string        &operation_name = "",
             const unsigned int        extra_size     = 0);
 
  void
  print_line_with_decoration(const ConditionalOStream &pcout,
                             const std::string        &text           = "",
                             const std::string        &operation_name = "",
                             const unsigned int        extra_size     = 0);
 
  void
  print_table(const ConditionalOStream   &pcout,
              const std::string          &title,
              const dealii::TableHandler &table);
 
  inline void
  print_header(const ConditionalOStream &pcout, const std::string &header)
  {
    print_decoration_line(pcout);
    print_line(pcout, std::string(0.5 * (max_text_width - header.size()), ' ') + header);
    print_decoration_line(pcout);
  }
 
  inline void
  print_end(const ConditionalOStream &pcout)
  {
    print_decoration_line(pcout);
    print_line(pcout, " end of simulation");
    print_decoration_line(pcout);
  }
 
  inline void
  print_start(const ConditionalOStream &pcout)
  {
    print_decoration_line(pcout);
    print_line(pcout, std::string(48, ' ') + "MeltPoolDG");
    print_decoration_line(pcout);
  }
 
  template <typename number>
  void
  print_formatted_norm(const ConditionalOStream &pcout,
                       const number              norm_value,
                       const std::string        &norm_id,
                       const std::string        &operation_name,
                       const unsigned int        precision   = 6,
                       const std::string        &norm_suffix = "L2",
                       const unsigned int        extra_size  = 0);
 
  template <typename number>
  void
  print_formatted_norm(const ConditionalOStream      &pcout,
                       const std::function<number()> &compute_norm,
                       const std::string             &norm_id,
                       const std::string             &operation_name,
                       const unsigned int             precision   = 6,
                       const std::string             &norm_suffix = "L2",
                       const unsigned int             extra_size  = 0);
} // namespace MeltPoolDG::Journal