Add progress output (idaholab#22906)

framework/include/outputs/ProgressOutput.h

@@ -0,0 +1,33 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* 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
+
+#include "Output.h"
+
+class Transient;
+
+class ProgressOutput : public Output
+{
+public:
+  static InputParameters validParams();
+
+  ProgressOutput(const InputParameters & parameters);
+
+protected:
+  void output() override;
+
+  Transient * _transient_executioner;
+
+  // display input file name in the progress bar title
+  const bool _use_filename;
+
+  // total length of the progress bar
+  const unsigned int _length;
+};

framework/include/utils/FormattedTable.h

@@ -249,11 +249,6 @@ class FormattedTable
                       std::vector<std::string>::iterator & col_begin,
                       std::vector<std::string>::iterator & col_end) const;
 
-  /**
-   * Returns the width of the terminal using sys/ioctl
-   */
-  unsigned short getTermWidth(bool use_environment) const;
-
   /**
    * Data structure for the console table:
    * The first part of the pair tracks the independent variable (normally time) and is associated

framework/include/utils/MooseUtils.h

@@ -286,6 +286,11 @@ std::string baseName(const std::string & name);
  */
 std::string hostname();
 
+/**
+ * Returns the width of the terminal using sys/ioctl
+ */
+unsigned short getTermWidth(bool use_environment);
+
 /**
  * @returns A cleaner representation of the c++ type \p cpp_type.
  */

framework/src/outputs/ProgressOutput.C

@@ -0,0 +1,65 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* 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
+
+#include "ProgressOutput.h"
+#include "Transient.h"
+
+registerMooseObject("PolarBearApp", ProgressOutput);
+
+InputParameters
+ProgressOutput::validParams()
+{
+  auto params = Output::validParams();
+  params.set<ExecFlagEnum>("execute_on") = {EXEC_TIMESTEP_END};
+  params.addParam<bool>(
+      "use_filename", true, "Put the input filename into the title of the progress bar");
+  return params;
+}
+
+ProgressOutput::ProgressOutput(const InputParameters & parameters)
+  : Output(parameters),
+    _transient_executioner(dynamic_cast<Transient *>(_app.getExecutioner())),
+    _use_filename(getParam<bool>("use_filename")),
+    _length(MooseUtils::getTermWidth(true))
+{
+}
+
+void
+ProgressOutput::output()
+{
+  if (_transient_executioner == nullptr || -_current_execute_flag != EXEC_TIMESTEP_END ||
+      !_transient)
+    return;
+
+  auto passed = _transient_executioner->getTime() - _transient_executioner->getStartTime();
+  auto total = _transient_executioner->endTime() - _transient_executioner->getStartTime();
+  if (total == 0)
+    return;
+
+  // length of filled portion
+  auto progress = std::round((passed * _length) / total);
+
+  // title string
+  std::string title = name();
+  if (_use_filename)
+    title += " (" + getMooseApp().getFileName() + ')';
+  if (title.length() >= _length - 1)
+    title = title.substr(0, _length - 4) + "...";
+
+  // top line
+  Moose::out << "+-" << title << std::string(_length - 1 - title.length(), '-') << "+\n";
+
+  // bar
+  Moose::out << '|' << std::string(progress, '#') << std::string(_length - progress, '.') << "|\n";
+
+  // bottom line
+  Moose::out << '+' << std::string(_length, '-') << "+\n";
+}

framework/src/utils/FormattedTable.C

@@ -16,12 +16,6 @@
 #include <iomanip>
 #include <iterator>
 
-// Used for terminal width
-#ifndef __WIN32__
-#include <sys/ioctl.h>
-#endif
-#include <cstdlib>
-
 const unsigned short FormattedTable::_column_width = 15;
 const unsigned short FormattedTable::_min_pps_width = 40;
 
@@ -258,9 +252,9 @@ FormattedTable::printTable(std::ostream & out,
   unsigned short term_width;
 
   if (suggested_term_width == "ENVIRONMENT")
-    term_width = getTermWidth(true);
+    term_width = MooseUtils::getTermWidth(true);
   else if (suggested_term_width == "AUTO")
-    term_width = getTermWidth(false);
+    term_width = MooseUtils::getTermWidth(false);
   else
     term_width = MooseUtils::stringToInteger(suggested_term_width);
 
@@ -583,54 +577,6 @@ FormattedTable::fillEmptyValues()
             std::dynamic_pointer_cast<TableValueBase>(std::make_shared<TableValue<char>>('0'));
 }
 
-unsigned short
-FormattedTable::getTermWidth(bool use_environment) const
-{
-#ifndef __WIN32__
-  struct winsize w;
-#else
-  struct
-  {
-    unsigned short ws_col;
-  } w;
-#endif
-  /**
-   * Initialize the value we intend to populate just in case
-   * the system call fails
-   */
-  w.ws_col = std::numeric_limits<unsigned short>::max();
-
-  if (use_environment)
-  {
-    char * pps_width = std::getenv("MOOSE_PPS_WIDTH");
-    if (pps_width != NULL)
-    {
-      std::stringstream ss(pps_width);
-      ss >> w.ws_col;
-    }
-  }
-  // Default to AUTO if no environment variable was set
-  if (w.ws_col == std::numeric_limits<unsigned short>::max())
-  {
-#ifndef __WIN32__
-    try
-    {
-      ioctl(0, TIOCGWINSZ, &w);
-    }
-    catch (...)
-#endif
-    {
-    }
-  }
-
-  // Something bad happened, make sure we have a sane value
-  // 132 seems good for medium sized screens, and is available as a GNOME preset
-  if (w.ws_col == std::numeric_limits<unsigned short>::max())
-    w.ws_col = 132;
-
-  return w.ws_col;
-}
-
 MooseEnum
 FormattedTable::getWidthModes()
 {

framework/src/utils/MooseUtils.C

@@ -34,6 +34,7 @@
 #include <istream>
 #include <iterator>
 #include <ctime>
+#include <cstdlib>
 
 // System includes
 #include <sys/stat.h>
@@ -46,6 +47,8 @@
 #include <windows.h>
 #include <winbase.h>
 #include <fileapi.h>
+#else
+#include <sys/ioctl.h>
 #endif
 
 namespace MooseUtils
@@ -649,6 +652,54 @@ hostname()
   return hostname;
 }
 
+unsigned short
+getTermWidth(bool use_environment)
+{
+#ifndef __WIN32__
+  struct winsize w;
+#else
+  struct
+  {
+    unsigned short ws_col;
+  } w;
+#endif
+  /**
+   * Initialize the value we intend to populate just in case
+   * the system call fails
+   */
+  w.ws_col = std::numeric_limits<unsigned short>::max();
+
+  if (use_environment)
+  {
+    char * pps_width = std::getenv("MOOSE_PPS_WIDTH");
+    if (pps_width != NULL)
+    {
+      std::stringstream ss(pps_width);
+      ss >> w.ws_col;
+    }
+  }
+  // Default to AUTO if no environment variable was set
+  if (w.ws_col == std::numeric_limits<unsigned short>::max())
+  {
+#ifndef __WIN32__
+    try
+    {
+      ioctl(0, TIOCGWINSZ, &w);
+    }
+    catch (...)
+#endif
+    {
+    }
+  }
+
+  // Something bad happened, make sure we have a sane value
+  // 132 seems good for medium sized screens, and is available as a GNOME preset
+  if (w.ws_col == std::numeric_limits<unsigned short>::max())
+    w.ws_col = 132;
+
+  return w.ws_col;
+}
+
 void
 MaterialPropertyStorageDump(
     const HashMap<const libMesh::Elem *, HashMap<unsigned int, MaterialProperties>> & props)