Console.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
// MOOSE includes
#include "TableOutput.h"
 
class Console : public TableOutput
{
public:
  static InputParameters validParams();
 
  Console(const InputParameters & parameters);
 
  virtual ~Console();
 
  virtual void initialSetup() override;
 
  virtual void timestepSetup() override;
 
  virtual void output() override;
 
  virtual std::string filename() override;
 
  static void petscSetupOutput();
 
  void meshChanged() override;
 
  static std::string
  outputNorm(const Real & old_norm, const Real & norm, const unsigned int precision = 6);
 
  MultiMooseEnum & systemInfoFlags()
  {
    if (!_allow_changing_sysinfo_flag)
      mooseError(
          "accessing console system information flags is not allowed after console initial setup");
    return _system_info_flags;
  }
 
  enum class TimeFormatEnum
  {
    PLAIN = 0,
    SECOND = 1,
    MINUTE = 2,
    HOUR = 3,
    DAY = 4,
    DTIME = 5
  };
 
  TimeFormatEnum & timeFormat() { return _time_format; }
 
protected:
  virtual void outputInput() override;
 
  virtual void outputScalarVariables() override;
 
  virtual void outputPostprocessors() override;
 
  virtual void outputVectorPostprocessors() override
  {
    mooseError("Can't currently output VectorPostprocessors to the screen");
  };
 
  virtual void outputReporters() override;
 
  virtual void outputSystemInformation() override;
 
  void writeTimestepInformation(bool output_dt);
 
  void write(std::string message, bool indent = true);
 
  void writeStreamToFile(bool append = true);
 
  void writeVariableNorms();
 
  std::string formatTime(const Real t) const;
 
  unsigned int _max_rows;
 
  MooseEnum _fit_mode;
 
  bool _scientific_time;
 
  bool _write_file;
 
  bool _write_screen;
 
  bool _verbose;
 
  std::stringstream _file_output_stream;
 
  bool _perf_log;
 
  unsigned int _perf_log_interval;
 
  bool _solve_log;
 
  bool _libmesh_log;
 
  bool _perf_header;
 
  bool _all_variable_norms;
 
  bool _outlier_variable_norms;
 
  std::vector<Real> _outlier_multiplier;
 
  unsigned int _precision;
 
  TimeFormatEnum _time_format;
 
  const bool _write_all_procs_to_files;
 
private:
  void mooseConsole(const std::string & message);
 
  const std::ostringstream & _console_buffer;
 
  Real _old_linear_norm;
 
  Real _old_nonlinear_norm;
 
  bool _print_mesh_changed_info;
 
  MultiMooseEnum _system_info_flags;
 
  friend class OutputWarehouse;
 
private:
  bool _allow_changing_sysinfo_flag;
 
  bool _last_message_ended_in_newline;
};