https://mooseframework.inl.gov
ReporterDebugOutput.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ReporterDebugOutput.h"
11 
12 // MOOSE includes
13 #include "FEProblemBase.h"
14 
16 
19 {
21  params.addClassDescription("Debug output object for displaying Reporter information.");
22  params.set<ExecFlagEnum>("execute_on") = EXEC_INITIAL;
23  return params;
24 }
25 
27 
28 void
30 {
31  _console << "\nDeclared/requested Reporter Information:\n\n "
34  << std::endl;
35 }
A MultiMooseEnum object to hold "execute_on" flags.
Definition: ExecFlagEnum.h:21
ReporterDebugOutput(const InputParameters &parameters)
void output() override
Overload this function with the desired output activities.
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
Based class for output objects.
Definition: Output.h:43
const ReporterData & getReporterData() const
Provides const access the ReporterData object.
static std::string getReporterInfo(const ReporterStateBase &state, const ReporterContextBase *context)
Gets information pertaining to the Reporter with state state and possibly context context...
Definition: ReporterData.C:203
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:185
registerMooseObject("MooseApp", ReporterDebugOutput)
Produces debug output for displaying Reporter information.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
std::string replaceAll(std::string str, const std::string &from, const std::string &to)
Replaces all occurrences of from in str with to and returns the result.
Definition: MooseUtils.C:141
static InputParameters validParams()
Definition: Output.C:32
const ExecFlagType EXEC_INITIAL
Definition: Moose.C:28