www.mooseframework.org
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
Console Class Reference

An output object for writing to the console (screen) More...

#include <Console.h>

Inheritance diagram for Console:
[legend]

Public Member Functions

 Console (const InputParameters &parameters)
 Class constructor. More...
 
virtual ~Console ()
 Destructor. More...
 
virtual void initialSetup () override
 Initial setup function Prints the system information, this is done here so that the system information is printed prior to any PETSc solve information. More...
 
virtual void output (const ExecFlagType &type) override
 Customizes the order of output for the various components as well as adds additional output such as timestep information and nonlinear/linear residual information. More...
 
virtual std::string filename () override
 Creates the output file name Appends the user-supplied 'file_base' input parameter with a '.txt' extension. More...
 
void meshChanged () override
 Performs console related printing when the mesh is changed. More...
 
MultiMooseEnumsystemInfoFlags ()
 Return system information flags. More...
 
virtual bool hasOutput ()
 Returns true if any of the other has methods return true. More...
 
bool hasOutput (const ExecFlagType &type)
 Tests that any output exist for the given output type. More...
 
bool hasNodalVariableOutput ()
 Returns true if there exists nodal nonlinear variables for output. More...
 
const std::set< std::string > & getNodalVariableOutput ()
 The list of nodal nonlinear variables names that are set for output. More...
 
bool hasElementalVariableOutput ()
 Returns true if there exists elemental nonlinear variables for output. More...
 
const std::set< std::string > & getElementalVariableOutput ()
 The list of elemental nonlinear variables names that are set for output. More...
 
bool hasScalarOutput ()
 Returns true if there exists scalar variables for output. More...
 
const std::set< std::string > & getScalarOutput ()
 The list of scalar variables names that are set for output. More...
 
bool hasPostprocessorOutput ()
 Returns true if there exists postprocessors for output. More...
 
const std::set< std::string > & getPostprocessorOutput ()
 The list of postprocessor names that are set for output. More...
 
bool hasVectorPostprocessorOutput ()
 Returns true if there exists VectorPostprocessors for output. More...
 
const std::set< std::string > & getVectorPostprocessorOutput ()
 The list of VectorPostprocessor names that are set for output. More...
 
const OutputOnWarehouseadvancedExecuteOn () const
 Get the current advanced 'execute_on' selections for display. More...
 
void setFileNumber (unsigned int num)
 Sets the file number manually. More...
 
unsigned int getFileNumber ()
 Return the current file number for this outputter. More...
 
virtual Real time () override
 Get the output time. More...
 
virtual Real timeOld ()
 Get the old output time. More...
 
virtual Real dt ()
 Get the current time step size. More...
 
virtual Real dtOld ()
 Get old time step size. More...
 
virtual int timeStep ()
 Get the current time step. More...
 
const unsigned int & interval () const
 Get the output interval. More...
 
const MultiMooseEnumexecuteOn () const
 Get the current 'execute_on' selections for display. More...
 
bool isAdvanced ()
 Returns true if this object is an AdvancedOutput object. More...
 
void allowOutput (bool state)
 Method for controlling the allow output state. More...
 
virtual void outputStep (const ExecFlagType &type)
 A single call to this function should output all the necessary data for a single timestep. More...
 
const std::string & name () const
 Get the name of the object. More...
 
const InputParametersparameters () const
 Get the parameters of the object. More...
 
template<typename T >
const T & getParam (const std::string &name) const
 Retrieve a parameter for the object. More...
 
bool isParamValid (const std::string &name) const
 Test if the supplied parameter is valid. More...
 
MooseAppgetMooseApp ()
 Get the MooseApp this object is associated with. More...
 
virtual bool enabled ()
 Return the enabled status of the object. More...
 
template<typename... Args>
void mooseError (Args &&...args) const
 
template<typename... Args>
void mooseWarning (Args &&...args) const
 
template<typename... Args>
void mooseDeprecated (Args &&...args) const
 
template<typename... Args>
void mooseInfo (Args &&...args) const
 
virtual void timestepSetup ()
 Gets called at the beginning of the timestep before this object is asked to do its job. More...
 
virtual void jacobianSetup ()
 Gets called just before the Jacobian is computed and before this object is asked to do its job. More...
 
virtual void residualSetup ()
 Gets called just before the residual is computed and before this object is asked to do its job. More...
 
virtual void subdomainSetup ()
 Gets called when the subdomain changes (i.e. More...
 
virtual const std::vector< ExecFlagType > & execFlags () const
 Get the execution flag for the object. More...
 
ExecFlagType execBitFlags () const
 Build and return the execution flags as a bitfield. More...
 

Static Public Member Functions

static void petscSetupOutput ()
 Output string for setting up PETSC output. More...
 
static InputParameters enableOutputTypes (const std::string &names=std::string())
 A method for enabling individual output type control. More...
 
static std::string getOutputFileBase (MooseApp &app, std::string suffix="_out")
 Returns the default output file base. More...
 
static MultiMooseEnum getExecuteOptions (std::string default_type="")
 Return the support output execution times. More...
 
static MultiMooseEnum getExecuteOptions ()
 Returns the available options for the 'execute_on' input parameters. More...
 
static void addDeprecatedInputParameters (InputParameters &params)
 A static helper for injecting deprecated parameters. More...
 

Public Attributes

const ConsoleStream _console
 An instance of helper class to write streams to the Console objects. More...
 

Protected Member Functions

void init ()
 Adds the printing of system information to the init() method. More...
 
virtual void outputInput () override
 Print the input file at the beginning of the simulation. More...
 
virtual void outputScalarVariables () override
 Prints the aux scalar variables table to the screen. More...
 
virtual void outputPostprocessors () override
 Prints the postprocessor table to the screen. More...
 
virtual void outputVectorPostprocessors () override
 Not implemented. More...
 
virtual void outputSystemInformation () override
 Print system information. More...
 
std::string outputNorm (const Real &old_norm, const Real &norm)
 A helper function for outputting norms in color. More...
 
void writeTimestepInformation ()
 Prints the time step information for the screen output. More...
 
void write (std::string message, bool indent=true)
 Write message to screen and/or file. More...
 
void writeStreamToFile (bool append=true)
 Write the file stream to the file. More...
 
void writeVariableNorms ()
 Print the L2-norms for each variable. More...
 
virtual bool shouldOutput (const ExecFlagType &type)
 Handles logic for determining if a step should be output. More...
 
virtual void outputNodalVariables ()
 Performs output of nodal nonlinear variables The child class must define this method to output the nonlinear variables as desired. More...
 
virtual void outputElementalVariables ()
 Performs output of elemental nonlinear variables The child class must define this method to output the nonlinear variables as desired. More...
 
bool checkFilename ()
 Checks the filename for output Checks the output against the 'output_if_base_contians' list. More...
 
virtual bool onInterval ()
 Returns true if the output interval is satisfied. More...
 
template<typename T >
T & declareRestartableData (std::string data_name)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableData (std::string data_name, const T &init_value)
 Declare a piece of data as "restartable" and initialize it. More...
 
template<typename T >
T & declareRestartableDataWithContext (std::string data_name, void *context)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableDataWithContext (std::string data_name, const T &init_value, void *context)
 Declare a piece of data as "restartable" and initialize it. More...
 

Protected Attributes

unsigned int _max_rows
 The max number of table rows. More...
 
MooseEnum _fit_mode
 The FormattedTable fit mode. More...
 
bool _scientific_time
 Toggle for outputting time in time and dt in scientific notation. More...
 
bool _write_file
 Flag for controlling outputting console information to a file. More...
 
bool _write_screen
 Flag for controlling outputting console information to screen. More...
 
bool _verbose
 Flag for writing detailed time step information. More...
 
std::stringstream _file_output_stream
 Stream for storing information to be written to a file. More...
 
bool _perf_log
 State for all performance logging. More...
 
unsigned int _perf_log_interval
 The interval at which the performance log is printed. More...
 
bool _solve_log
 State for solve performance log. More...
 
bool _libmesh_log
 Control the display libMesh performance log. More...
 
bool _perf_header
 State for the performance log header information. More...
 
bool _all_variable_norms
 Flag for writing all variable norms. More...
 
bool _outlier_variable_norms
 Flag for writing outlier variable norms. More...
 
std::vector< Real > _outlier_multiplier
 Multipliers for coloring variable residual norms (default [2, 0.8]) More...
 
unsigned int _precision
 Number of significant digits. More...
 
bool _tables_restartable
 Flag for allowing all table data to become restartable. More...
 
FormattedTable_postprocessor_table
 Table containing postprocessor data. More...
 
std::map< std::string, FormattedTable_vector_postprocessor_tables
 Formatted tables for outputting vector postprocessor data. One per VectorPostprocessor. More...
 
std::map< std::string, FormattedTable > & _vector_postprocessor_time_tables
 Table for vector postprocessor time data. More...
 
FormattedTable_scalar_table
 Table containing scalar aux variables. More...
 
FormattedTable_all_data_table
 Table containing postprocessor values and scalar aux variables. More...
 
bool _time_data
 Enable/disable VecptorPostprocessor time data file. More...
 
bool _time_column
 Enable/disable output of time column for Postprocessors. More...
 
std::string _file_base
 The base filename from the input paramaters. More...
 
unsigned int & _file_num
 A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus) More...
 
unsigned int _padding
 Number of digits to pad the extensions. More...
 
std::vector< std::string > _output_if_base_contains
 Storage for 'output_if_base_contains'. More...
 
Real _norm
 Current norm returned from PETSc. More...
 
PetscInt _nonlinear_iter
 Current non-linear iteration returned from PETSc. More...
 
PetscInt _linear_iter
 Current linear iteration returned from PETSc. More...
 
FEProblemBase_problem_ptr
 Pointer the the FEProblemBase object for output object (use this) More...
 
bool _transient
 Transient flag (true = transient) More...
 
bool _use_displaced
 Flag for using displaced mesh. More...
 
EquationSystems * _es_ptr
 Reference the the libMesh::EquationSystems object that contains the data. More...
 
bool _sequence
 Flag for forcing call to outputSetup() with every call to output() (restartable) More...
 
MultiMooseEnum _execute_on
 The common Execution types; this is used as the default execution type for everything except system information and input. More...
 
Real & _time
 The current time for output purposes. More...
 
Real & _time_old
 The old time. More...
 
int & _t_step
 The current time step. More...
 
Real & _dt
 Time step delta. More...
 
Real & _dt_old
 Old time step delta. More...
 
unsigned int _num
 The number of outputs written. More...
 
const unsigned int _interval
 The output time step interval. More...
 
std::set< Real > _sync_times
 Sync times for this outputter. More...
 
Real _start_time
 Start outputting time. More...
 
Real _end_time
 End outputting time. More...
 
Real _t_tol
 Time checking tolerance. More...
 
bool _sync_only
 Flag for only executing at sync times. More...
 
bool _initialized
 True if init() has been called. More...
 
bool _allow_output
 Flag for disabling output. More...
 
bool _is_advanced
 Flag for advanced output testing. More...
 
OutputOnWarehouse _advanced_execute_on
 Storage for the individual component execute flags. More...
 
MooseApp_app
 The MooseApp this object is associated with. More...
 
const InputParameters_pars
 Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...
 
const std::string & _name
 The name of this object, reference to value stored in InputParameters. More...
 
const bool & _enabled
 Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects. More...
 
FEProblemBase_mci_feproblem
 Reference to FEProblemBase instance. More...
 
std::vector< ExecFlagType_exec_flags
 execution flag (when is the object executed/evaluated) More...
 
const ExecFlagType_current_execute_flag
 Reference to FEProblemBase. More...
 

Private Member Functions

void mooseConsole (const std::string &message)
 Add a message to the output streams. More...
 

Private Attributes

const std::ostringstream & _console_buffer
 Reference to cached messages from calls to _console. More...
 
Real _old_linear_norm
 Storage for the old linear residual (needed for color output and only when used when printing to the screen) More...
 
Real _old_nonlinear_norm
 Storage for the old non linear residual (needed for color output and only when used when printing to the screen) More...
 
bool _print_mesh_changed_info
 Flag for printing mesh information when the mesh changes. More...
 
MultiMooseEnum _system_info_flags
 Flags for controlling the what simulations information is shown. More...
 
bool _allow_changing_sysinfo_flag
 A boolean for protecting _system_info_flags from being changed undesirably. More...
 

Friends

class OutputWarehouse
 

Detailed Description

An output object for writing to the console (screen)

Definition at line 30 of file Console.h.

Constructor & Destructor Documentation

Console::Console ( const InputParameters parameters)

Class constructor.

Definition at line 152 of file Console.C.

153  : TableOutput(parameters),
154  _max_rows(getParam<unsigned int>("max_rows")),
155  _fit_mode(getParam<MooseEnum>("fit_mode")),
156  _scientific_time(getParam<bool>("scientific_time")),
157  _write_file(getParam<bool>("output_file")),
158  _write_screen(getParam<bool>("output_screen")),
159  _verbose(getParam<bool>("verbose")),
160  _perf_log(getParam<bool>("perf_log") || _app.getParam<bool>("timing")),
161  _perf_log_interval(getParam<unsigned int>("perf_log_interval")),
162  _solve_log(isParamValid("solve_log") ? getParam<bool>("solve_log") : _perf_log),
163  _libmesh_log(getParam<bool>("libmesh_log")),
164  _perf_header(isParamValid("perf_header") ? getParam<bool>("perf_header") : _perf_log),
165  _all_variable_norms(getParam<bool>("all_variable_norms")),
166  _outlier_variable_norms(getParam<bool>("outlier_variable_norms")),
167  _outlier_multiplier(getParam<std::vector<Real>>("outlier_multiplier")),
168  _precision(isParamValid("time_precision") ? getParam<unsigned int>("time_precision") : 0),
170  _old_linear_norm(std::numeric_limits<Real>::max()),
171  _old_nonlinear_norm(std::numeric_limits<Real>::max()),
172  _print_mesh_changed_info(getParam<bool>("print_mesh_changed_info")),
173  _system_info_flags(getParam<MultiMooseEnum>("system_info")),
175 {
176  // Apply the special common console flags (print_...)
178  const auto & actions = awh.getActionListByName("common_output");
179  mooseAssert(actions.size() == 1, "Should be only one common_output Action");
180  Action * common_action = *actions.begin();
181 
182  // Honor the 'print_linear_residuals' option, only if 'execute_on' has not been set by the user
183  if (!parameters.isParamSetByUser("execute_on"))
184  {
185  if (common_action->getParam<bool>("print_linear_residuals"))
186  _execute_on.push_back("linear");
187  else
188  _execute_on.erase("linear");
189  }
190 
191  if (!_pars.isParamSetByUser("perf_log") && common_action->getParam<bool>("print_perf_log"))
192  {
193  _perf_log = true;
194  _solve_log = true;
195  }
196 
197  if (_app.name() != "main" &&
198  (_pars.isParamSetByUser("perf_log") || _pars.isParamSetByUser("perf_log_interval") ||
199  _pars.isParamSetByUser("solve_log") || _pars.isParamSetByUser("perf_header") ||
200  _pars.isParamSetByUser("libmesh_log") ||
201  common_action->parameters().isParamSetByUser("print_perf_log")))
202  mooseWarning("Performance logging cannot currently be controlled from a Multiapp, please set "
203  "all performance options in the main input file");
204 
205  // Append the common 'execute_on' to the setting for this object
206  // This is unique to the Console object, all other objects inherit from the common options
207  const MultiMooseEnum & common_execute_on = common_action->getParam<MultiMooseEnum>("execute_on");
208  for (auto & mme : common_execute_on)
209  _execute_on.push_back(mme);
210 
211  // If --show-outputs is used, enable it
212  if (_app.getParam<bool>("show_outputs"))
213  _system_info_flags.push_back("output");
214 
215  // Set output coloring
216  if (Moose::colorConsole())
217  {
218  char * term_env = getenv("TERM");
219  if (term_env)
220  {
221  std::string term(term_env);
222  if (term != "xterm-256color" && term != "xterm")
223  Moose::setColorConsole(false);
224  }
225  }
226 }
bool _libmesh_log
Control the display libMesh performance log.
Definition: Console.h:189
void mooseWarning(Args &&...args) const
Definition: MooseObject.h:89
bool colorConsole()
Returns whether Console coloring is turned on (default: true).
Definition: Moose.C:1270
unsigned int _precision
Number of significant digits.
Definition: Console.h:204
bool isParamSetByUser(const std::string &name) const
Method returns true if the parameter was by the user.
MultiMooseEnum _execute_on
The common Execution types; this is used as the default execution type for everything except system i...
Definition: Output.h:186
MooseEnum _fit_mode
The FormattedTable fit mode.
Definition: Console.h:162
bool _all_variable_norms
Flag for writing all variable norms.
Definition: Console.h:195
bool _verbose
Flag for writing detailed time step information.
Definition: Console.h:174
const std::list< Action * > & getActionListByName(const std::string &task) const
Retrieve a constant list of Action pointers associated with the passed in task.
bool _write_screen
Flag for controlling outputting console information to screen.
Definition: Console.h:171
const std::ostringstream & _console_buffer
Reference to cached messages from calls to _console.
Definition: Console.h:220
Storage for action instances.
const std::string & name() const
Get the name of the object.
Definition: MooseApp.h:70
bool _allow_changing_sysinfo_flag
A boolean for protecting _system_info_flags from being changed undesirably.
Definition: Console.h:238
Base class for actions.
Definition: Action.h:39
bool _outlier_variable_norms
Flag for writing outlier variable norms.
Definition: Console.h:198
bool _perf_header
State for the performance log header information.
Definition: Console.h:192
MultiMooseEnum _system_info_flags
Flags for controlling the what simulations information is shown.
Definition: Console.h:232
TableOutput(const InputParameters &parameters)
Class constructor.
Definition: TableOutput.C:59
bool _solve_log
State for solve performance log.
Definition: Console.h:186
unsigned int _perf_log_interval
The interval at which the performance log is printed.
Definition: Console.h:183
ActionWarehouse & actionWarehouse()
Definition: MooseApp.h:130
std::ostringstream & consoleBuffer()
The buffered messages stream for Console objects.
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
Definition: MooseObject.h:67
void erase(const std::string &names)
Un-assign a value.
unsigned int _max_rows
The max number of table rows.
Definition: Console.h:159
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition: MooseObject.h:122
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:111
Real _old_nonlinear_norm
Storage for the old non linear residual (needed for color output and only when used when printing to ...
Definition: Console.h:226
bool _write_file
Flag for controlling outputting console information to a file.
Definition: Console.h:168
bool _perf_log
State for all performance logging.
Definition: Console.h:180
std::vector< Real > _outlier_multiplier
Multipliers for coloring variable residual norms (default [2, 0.8])
Definition: Console.h:201
const T & getParam(const std::string &name)
Retrieve a parameter for the object.
Definition: MooseApp.h:738
void push_back(const std::string &names)
Insert operators Operator to insert (push_back) values into the enum.
bool setColorConsole(bool use_color, bool force=false)
Turns color escape sequences on/off for info written to stdout.
Definition: Moose.C:1276
Real _old_linear_norm
Storage for the old linear residual (needed for color output and only when used when printing to the ...
Definition: Console.h:223
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
bool _scientific_time
Toggle for outputting time in time and dt in scientific notation.
Definition: Console.h:165
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
bool _print_mesh_changed_info
Flag for printing mesh information when the mesh changes.
Definition: Console.h:229
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
Definition: MooseApp.C:841
Console::~Console ( )
virtual

Destructor.

Definition at line 228 of file Console.C.

229 {
230  // Write the libMesh performance log header
231  if (_perf_header)
232  write(Moose::perf_log.get_info_header(), false);
233 
234  // Write the solve log (Moose Test Performance)
235  if (_solve_log)
236  write(Moose::perf_log.get_perf_info(), false);
237 
238  // Write the libMesh log
239  if (_libmesh_log)
240  write(libMesh::perflog.get_perf_info(), false);
241 
242  // Write the file output stream
244 
245  // Disable logging so that the destructor in libMesh doesn't print
246  Moose::perf_log.disable_logging();
247  libMesh::perflog.disable_logging();
248 }
bool _libmesh_log
Control the display libMesh performance log.
Definition: Console.h:189
bool _perf_header
State for the performance log header information.
Definition: Console.h:192
bool _solve_log
State for solve performance log.
Definition: Console.h:186
void write(std::string message, bool indent=true)
Write message to screen and/or file.
Definition: Console.C:644
PerfLog perf_log
Perflog to be used by applications.
void writeStreamToFile(bool append=true)
Write the file stream to the file.
Definition: Console.C:377

Member Function Documentation

static void Output::addDeprecatedInputParameters ( InputParameters params)
staticinherited

A static helper for injecting deprecated parameters.

const OutputOnWarehouse & AdvancedOutput::advancedExecuteOn ( ) const
virtualinherited

Get the current advanced 'execute_on' selections for display.

Reimplemented from Output.

Definition at line 698 of file AdvancedOutput.C.

699 {
700  return _advanced_execute_on;
701 }
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:237
void Output::allowOutput ( bool  state)
inlineinherited

Method for controlling the allow output state.

Parameters
stateThe state to set the allow flag to

Definition at line 125 of file Output.h.

125 { _allow_output = state; }
bool _allow_output
Flag for disabling output.
Definition: Output.h:228
bool FileOutput::checkFilename ( )
protectedinherited

Checks the filename for output Checks the output against the 'output_if_base_contians' list.

Returns
Returns true if the filename is valid for output

Definition at line 145 of file FileOutput.C.

Referenced by FileOutput::shouldOutput(), and AdvancedOutput::shouldOutput().

146 {
147  // Return true if 'output_if_base_contains' is not utilized
148  if (_output_if_base_contains.empty())
149  return true;
150 
151  // Assumed output is false
152  bool output = false;
153 
154  // Loop through each string in the list
155  for (const auto & search_string : _output_if_base_contains)
156  {
157  // Search for the string in the file base, if found set the output to true and break the loop
158  if (_file_base.find(search_string) != std::string::npos)
159  {
160  output = true;
161  break;
162  }
163  }
164 
165  // Return the value
166  return output;
167 }
virtual void output(const ExecFlagType &type)=0
Overload this function with the desired output activities.
std::string _file_base
The base filename from the input paramaters.
Definition: FileOutput.h:87
std::vector< std::string > _output_if_base_contains
Storage for &#39;output_if_base_contains&#39;.
Definition: FileOutput.h:96
template<typename T >
T & Restartable::declareRestartableData ( std::string  data_name)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)

Definition at line 224 of file Restartable.h.

225 {
226  return declareRestartableDataWithContext<T>(data_name, NULL);
227 }
template<typename T >
T & Restartable::declareRestartableData ( std::string  data_name,
const T &  init_value 
)
protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data

Definition at line 231 of file Restartable.h.

232 {
233  return declareRestartableDataWithContext<T>(data_name, init_value, NULL);
234 }
template<typename T >
T & Restartable::declareRestartableDataWithContext ( std::string  data_name,
void *  context 
)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
contextContext pointer that will be passed to the load and store functions

Definition at line 238 of file Restartable.h.

239 {
241  mooseError("No valid SubProblem found for ", _restartable_system_name, "/", _restartable_name);
242 
243  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
244  RestartableData<T> * data_ptr = new RestartableData<T>(full_name, context);
245 
247 
248  return data_ptr->get();
249 }
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:202
void mooseError(Args &&...args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:182
std::string _restartable_name
The name of the object.
Definition: Restartable.h:196
void registerRestartableDataOnSubProblem(std::string name, RestartableDataValue *data, THREAD_ID tid)
Helper function so we don&#39;t have to include SubProblem in the header.
Definition: Restartable.C:49
Concrete definition of a parameter value for a specified type.
SubProblem * _restartable_subproblem
Pointer to the SubProblem class.
Definition: Restartable.h:208
THREAD_ID _restartable_tid
The thread ID for this object.
Definition: Restartable.h:205
template<typename T >
T & Restartable::declareRestartableDataWithContext ( std::string  data_name,
const T &  init_value,
void *  context 
)
protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data
contextContext pointer that will be passed to the load and store functions

Definition at line 253 of file Restartable.h.

256 {
258  mooseError("No valid SubProblem found for ", _restartable_system_name, "/", _restartable_name);
259 
260  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
261  RestartableData<T> * data_ptr = new RestartableData<T>(full_name, context);
262 
263  data_ptr->set() = init_value;
264 
266 
267  return data_ptr->get();
268 }
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:202
void mooseError(Args &&...args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:182
std::string _restartable_name
The name of the object.
Definition: Restartable.h:196
void registerRestartableDataOnSubProblem(std::string name, RestartableDataValue *data, THREAD_ID tid)
Helper function so we don&#39;t have to include SubProblem in the header.
Definition: Restartable.C:49
Concrete definition of a parameter value for a specified type.
SubProblem * _restartable_subproblem
Pointer to the SubProblem class.
Definition: Restartable.h:208
THREAD_ID _restartable_tid
The thread ID for this object.
Definition: Restartable.h:205
Real Output::dt ( )
virtualinherited

Get the current time step size.

Definition at line 215 of file Output.C.

Referenced by writeTimestepInformation().

216 {
217  if (_transient)
218  return _dt;
219  else
220  return 1;
221 }
bool _transient
Transient flag (true = transient)
Definition: Output.h:174
Real & _dt
Time step delta.
Definition: Output.h:198
Real Output::dtOld ( )
virtualinherited

Get old time step size.

Definition at line 224 of file Output.C.

225 {
226  if (_transient)
227  return _dt_old;
228  else
229  return 1;
230 }
Real & _dt_old
Old time step delta.
Definition: Output.h:201
bool _transient
Transient flag (true = transient)
Definition: Output.h:174
virtual bool MooseObject::enabled ( )
inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 77 of file MooseObject.h.

Referenced by EigenKernel::enabled().

77 { return _enabled; }
const bool & _enabled
Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.
Definition: MooseObject.h:117
InputParameters AdvancedOutput::enableOutputTypes ( const std::string &  names = std::string())
staticinherited

A method for enabling individual output type control.

Parameters
names(optional) Space separated of output type names that are supported by this Output object, if this is omitted all outputs types will be supported. The list of available output types is given below.

Output objects vary widely in what type of outputs they support (e.g., elemental variables, or postprocessor data). This method provides the user a means for controlling the types of outputs that are supported for the object being created. This is a static method that MUST be used to append parameters inside the objects validParams function.

List of Output Types and Method Names The output system is designed around overloading virtual method calls to output the various output types, the following list gives the name of the output type and the associated virtual method that should be overloaded to perform the output in the object being created.

Type virtual Method Name


nodal outputNodalVariables() elemental outputElementalVariables() scalar outputScalarVariables() postprocessor outputPostprocessors() vector_postprocessor outputVectorPostprocessors() input outputInput() system_information outputSystemInformation()

See also
CSV Exodus

Definition at line 106 of file AdvancedOutput.C.

Referenced by validParams< Console >(), validParams< Exodus >(), validParams< Nemesis >(), and validParams< TableOutput >().

107 {
108  // The parameters object that will be returned
110 
111  // Get the MultiEnum of output types
112  MultiMooseEnum output_types = getOutputTypes();
113 
114  // Update the enum of output types to append
115  if (names.empty())
116  output_types = output_types.getRawNames();
117  else
118  output_types = names;
119 
120  // Add the parameters and return them
121  addValidParams(params, output_types);
122  return params;
123 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters emptyInputParameters()
static void addValidParams(InputParameters &params, const MultiMooseEnum &types)
Method for defining the available parameters based on the types of outputs.
std::string getRawNames() const
Method for returning the raw name strings for this instance.
static MultiMooseEnum getOutputTypes()
Get the supported types of output (e.g., postprocessors, etc.)
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
ExecFlagType SetupInterface::execBitFlags ( ) const
inherited

Build and return the execution flags as a bitfield.

Definition at line 100 of file SetupInterface.C.

Referenced by EigenExecutionerBase::init().

101 {
102  unsigned int exec_bit_field = EXEC_NONE;
103  for (unsigned int i = 0; i < _exec_flags.size(); ++i)
104  exec_bit_field |= _exec_flags[i];
105 
106  return static_cast<ExecFlagType>(exec_bit_field);
107 }
std::vector< ExecFlagType > _exec_flags
execution flag (when is the object executed/evaluated)
ExecFlagType
Execution flags - when is the object executed/evaluated.
Definition: MooseTypes.h:90
const std::vector< ExecFlagType > & SetupInterface::execFlags ( ) const
virtualinherited

Get the execution flag for the object.

Reimplemented in MultiAppTransfer.

Definition at line 94 of file SetupInterface.C.

Referenced by ExecuteMooseObjectWarehouse< T >::addObjectMask(), and MultiAppTransfer::execFlags().

95 {
96  return _exec_flags;
97 }
std::vector< ExecFlagType > _exec_flags
execution flag (when is the object executed/evaluated)
const MultiMooseEnum & Output::executeOn ( ) const
inherited

Get the current 'execute_on' selections for display.

Definition at line 239 of file Output.C.

240 {
241  return _execute_on;
242 }
MultiMooseEnum _execute_on
The common Execution types; this is used as the default execution type for everything except system i...
Definition: Output.h:186
std::string Console::filename ( )
overridevirtual

Creates the output file name Appends the user-supplied 'file_base' input parameter with a '.txt' extension.

Returns
A string containing the output filename

Reimplemented from FileOutput.

Definition at line 306 of file Console.C.

Referenced by writeStreamToFile().

307 {
308  return _file_base + ".txt";
309 }
std::string _file_base
The base filename from the input paramaters.
Definition: FileOutput.h:87
const std::set< std::string > & AdvancedOutput::getElementalVariableOutput ( )
inherited

The list of elemental nonlinear variables names that are set for output.

Returns
A vector of strings containing the names of the nonlinear variables for output
See also
hasElementalVariableOutput

Definition at line 656 of file AdvancedOutput.C.

Referenced by Exodus::outputElementalVariables().

657 {
658  return _execute_data["elemental"].output;
659 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.
MultiMooseEnum SetupInterface::getExecuteOptions ( )
staticinherited

Returns the available options for the 'execute_on' input parameters.

Returns
A MooseEnum with the available 'execute_on' options, the default is 'residual'

Definition at line 110 of file SetupInterface.C.

Referenced by AddNodalNormalsAction::act(), AdvancedOutput::addValidParams(), AdvancedOutput::initExecutionTypes(), OutputOnWarehouse::OutputOnWarehouse(), validParams< CommonOutputAction >(), validParams< Output >(), and validParams< SetupInterface >().

111 {
112  return MultiMooseEnum("none=0x00 initial=0x01 linear=0x02 nonlinear=0x04 timestep_end=0x08 "
113  "timestep_begin=0x10 final=0x20 custom=0x100",
114  "linear");
115 }
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
MultiMooseEnum Output::getExecuteOptions ( std::string  default_type = "")
staticinherited

Return the support output execution times.

Parameters
default_typeThe default MultiMooseEnum option

Definition at line 83 of file Output.C.

84 {
85  // Build the string of options
86  std::string options = "none=0x00 initial=0x01 linear=0x02 nonlinear=0x04 timestep_end=0x08 "
87  "timestep_begin=0x10 final=0x20 failed=0x80";
88 
89  // The numbers associated must be in sync with the ExecFlagType in Moose.h
90  return MultiMooseEnum(options, default_type);
91 }
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
unsigned int FileOutput::getFileNumber ( )
inherited

Return the current file number for this outputter.

This method was implemented for the MultiApp system, particularly when reseting an application and a new output file is desired after the reset.

Definition at line 182 of file FileOutput.C.

Referenced by OutputWarehouse::getFileNumbers().

183 {
184  return _file_num;
185 }
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:90
MooseApp& MooseObject::getMooseApp ( )
inlineinherited

Get the MooseApp this object is associated with.

Definition at line 72 of file MooseObject.h.

Referenced by RestartableDataIO::createBackup(), RestartableDataIO::deserializeRestartableData(), Resurrector::restartRestartableData(), and RestartableDataIO::restoreBackup().

72 { return _app; }
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
const std::set< std::string > & AdvancedOutput::getNodalVariableOutput ( )
inherited

The list of nodal nonlinear variables names that are set for output.

Returns
A vector of strings containing the names of the nodal nonlinear variables for output

Note: The list returned by this will contain the names of both elemental and nodal variable names if 'elemental_as_nodal = true' in the input file. The libMesh output system (EquationSystems::build_solution_vector) performs the correct action within the solution vector by setting the nodal values as the average of the values for each of the element that the node shares.

See also
hasNodalVariableOutput

Definition at line 644 of file AdvancedOutput.C.

Referenced by Exodus::outputNodalVariables().

645 {
646  return _execute_data["nodal"].output;
647 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.
std::string FileOutput::getOutputFileBase ( MooseApp app,
std::string  suffix = "_out" 
)
staticinherited

Returns the default output file base.

Returns
The name of the input file with '_out' append to the end

This method is static to allow for outside objects to call it, namely CommonOutputAction::setRecoverFileBase().

See also
CommonOutputAction::setRecoverFileBase()

Definition at line 112 of file FileOutput.C.

Referenced by FileOutput::FileOutput(), and MooseApp::getCheckpointFiles().

113 {
114  // If the App has an outputfile, then use it (MultiApp scenario)
115  if (!app.getOutputFileBase().empty())
116  return app.getOutputFileBase();
117 
118  // If the output base is not set it must be determined from the input file
119  /* This will only return a non-empty string if the setInputFileName() was called, which is
120  * generally not the case. One exception is when CoupledExecutioner is used */
121  std::string input_filename = app.getInputFileName();
122  if (input_filename.empty())
123  input_filename = app.getFileName();
124 
125  // Assert that the filename is not empty
126  mooseAssert(!input_filename.empty(), "Input Filename is NULL");
127 
128  // Determine location of "." in extension, assert if it is not found
129  size_t pos = input_filename.find_last_of('.');
130  mooseAssert(pos != std::string::npos, "Unable to determine suffix of input file name");
131 
132  // Append the "_out" to the name and return it
133  return input_filename.substr(0, pos) + suffix;
134 }
std::string getOutputFileBase()
Override the selection of the output file base name.
Definition: MooseApp.C:538
std::string getInputFileName()
Returns the input file name that was set with setInputFileName.
Definition: MooseApp.h:144
std::string getFileName(bool stripLeadingPath=true) const
Return the filename that was parsed.
Definition: MooseApp.C:835
template<typename T >
const T & MooseObject::getParam ( const std::string &  name) const
inherited

Retrieve a parameter for the object.

Parameters
nameThe name of the parameter
Returns
The value of the parameter

Definition at line 122 of file MooseObject.h.

Referenced by FEProblemBase::addMaterial(), ConstraintWarehouse::addObject(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromXandY(), EigenKernel::EigenKernel(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), GenericConstantRankTwoTensor::GenericConstantRankTwoTensor(), TimeSequenceStepper::init(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), initialSetup(), AdvancedOutput::initialSetup(), SideSetsBetweenSubdomains::modify(), MeshExtruder::modify(), AddExtraNodeset::modify(), SideSetsAroundSubdomain::modify(), RenameBlock::modify(), MooseObject::parameters(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), TimePeriod::TimePeriod(), and VectorOfPostprocessors::VectorOfPostprocessors().

123 {
124  return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
125 }
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:47
static const T & getParamHelper(const std::string &name, const InputParameters &pars, const T *the_type)
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:111
const std::set< std::string > & AdvancedOutput::getPostprocessorOutput ( )
inherited

The list of postprocessor names that are set for output.

Returns
A vector of strings containing the names of the postprocessor variables for output
See also
hasPostprocessorOutput

Definition at line 680 of file AdvancedOutput.C.

Referenced by TableOutput::outputPostprocessors(), Nemesis::outputPostprocessors(), and Exodus::outputPostprocessors().

681 {
682  return _execute_data["postprocessors"].output;
683 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.
const std::set< std::string > & AdvancedOutput::getScalarOutput ( )
inherited

The list of scalar variables names that are set for output.

Returns
A vector of strings containing the names of the scalar variables for output
See also
hasScalarVariableOutput

Definition at line 668 of file AdvancedOutput.C.

Referenced by TableOutput::outputScalarVariables(), Nemesis::outputScalarVariables(), and Exodus::outputScalarVariables().

669 {
670  return _execute_data["scalars"].output;
671 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.
const std::set< std::string > & AdvancedOutput::getVectorPostprocessorOutput ( )
inherited

The list of VectorPostprocessor names that are set for output.

Returns
A vector of strings containing the names of the VectorPostprocessor variables for output
See also
hasVectorPostprocessorOutput

Definition at line 692 of file AdvancedOutput.C.

Referenced by TableOutput::outputVectorPostprocessors().

693 {
694  return _execute_data["vector_postprocessors"].output;
695 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.
bool AdvancedOutput::hasElementalVariableOutput ( )
inherited

Returns true if there exists elemental nonlinear variables for output.

Returns
True if nonlinear variable output exists
See also
getElementalVariableOutput

Definition at line 650 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup().

651 {
652  return hasOutputHelper("elemental");
653 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.
bool AdvancedOutput::hasNodalVariableOutput ( )
inherited

Returns true if there exists nodal nonlinear variables for output.

Returns
True if nonlinear variable output exists
See also
getNodalVariableOutput

Definition at line 638 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup(), and Exodus::outputElementalVariables().

639 {
640  return hasOutputHelper("nodal");
641 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.
bool AdvancedOutput::hasOutput ( )
virtualinherited

Returns true if any of the other has methods return true.

Definition at line 350 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup(), Exodus::output(), and AdvancedOutput::shouldOutput().

351 {
352  // Test that variables exist for output AND that output execution flags are valid
353  for (const auto & it : _execute_data)
354  if (!(it.second).output.empty() && _advanced_execute_on.contains(it.first) &&
355  _advanced_execute_on[it.first].isValid())
356  return true;
357 
358  // Test execution flags for non-variable output
359  if (_advanced_execute_on.contains("system_information") &&
360  _advanced_execute_on["system_information"].isValid())
361  return true;
362  if (_advanced_execute_on.contains("input") && _advanced_execute_on["input"].isValid())
363  return true;
364 
365  return false;
366 }
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:237
OutputDataWarehouse _execute_data
Storage structures for the various output types.
bool contains(const std::string &name)
A method for testing of a key exists.
bool AdvancedOutput::hasOutput ( const ExecFlagType type)
inherited

Tests that any output exist for the given output type.

See also
Exodus

Definition at line 338 of file AdvancedOutput.C.

339 {
340  // If any of the component outputs are true, then there is some output to perform
341  for (const auto & it : _advanced_execute_on)
342  if (wantOutput(it.first, type))
343  return true;
344 
345  // There is nothing to output
346  return false;
347 }
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:237
bool wantOutput(const std::string &name, const ExecFlagType &type)
Handles logic for determining if a step should be output.
MatType type
bool AdvancedOutput::hasPostprocessorOutput ( )
inherited

Returns true if there exists postprocessors for output.

Returns
True if postprocessor output exists
See also
getPostprocessorOutput

Definition at line 674 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup().

675 {
676  return hasOutputHelper("postprocessors");
677 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.
bool AdvancedOutput::hasScalarOutput ( )
inherited

Returns true if there exists scalar variables for output.

Returns
True if scalar variable output exists
See also
getScalarVariableOutput

Definition at line 662 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup().

663 {
664  return hasOutputHelper("scalars");
665 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.
bool AdvancedOutput::hasVectorPostprocessorOutput ( )
inherited

Returns true if there exists VectorPostprocessors for output.

Returns
True if VectorPostprocessor output exists
See also
getVectorPostprocessorOutput

Definition at line 686 of file AdvancedOutput.C.

687 {
688  return hasOutputHelper("vector_postprocessors");
689 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.
void Console::init ( )
protected

Adds the printing of system information to the init() method.

Referenced by systemInfoFlags().

void Console::initialSetup ( )
overridevirtual

Initial setup function Prints the system information, this is done here so that the system information is printed prior to any PETSc solve information.

Reimplemented from AdvancedOutput.

Definition at line 251 of file Console.C.

252 {
253  // Only allow the main app to change the perf_log settings.
254  if (_app.name() == "main")
255  {
258 
259  // Disable performance logging if nobody needs logging
261  Moose::perf_log.disable_logging();
262 
263  // Disable libMesh log
264  if (!_libmesh_log)
265  libMesh::perflog.disable_logging();
266  }
267 
268  // system info flag can be changed only before console initial setup
270 
271  // If execute_on = 'initial' perform the output
272  if (wantOutput("system_information", EXEC_INITIAL))
274 
275  // Call the base class method
277 
278  // If file output is desired, wipe out the existing file if not recovering
279  if (!_app.isRecovering())
280  writeStreamToFile(false);
281 
282  // Enable verbose output if Executioner has it enabled
283  if (_app.getExecutioner()->isParamValid("verbose") &&
284  _app.getExecutioner()->getParam<bool>("verbose"))
285  _verbose = true;
286 
287  // Display a message to indicate the application is running (useful for MultiApps)
289  write(std::string("\nRunning App: ") + _app.name() + "\n");
290 
291  // If the user adds "final" to the execute on, append this to the postprocessors, scalars, etc.,
292  // but only
293  // if the parameter (e.g., postprocessor_execute_on) has not been modified by the user.
294  if (_execute_on.contains("final"))
295  {
296  if (!_pars.isParamSetByUser("postprocessor_execute_on"))
297  _advanced_execute_on["postprocessors"].push_back("final");
298  if (!_pars.isParamSetByUser("scalars_execute_on"))
299  _advanced_execute_on["scalars"].push_back("final");
300  if (!_pars.isParamSetByUser("vector_postprocessor_execute_on"))
301  _advanced_execute_on["vector_postprocessors"].push_back("final");
302  }
303 }
bool _libmesh_log
Control the display libMesh performance log.
Definition: Console.h:189
bool isParamSetByUser(const std::string &name) const
Method returns true if the parameter was by the user.
bool isRecovering() const
Whether or not this is a "recover" calculation.
Definition: MooseApp.C:608
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:237
bool hasMultiApps() const
Returns whether or not the current simulation has any multiapps.
MultiMooseEnum _execute_on
The common Execution types; this is used as the default execution type for everything except system i...
Definition: Output.h:186
unsigned int multiAppLevel() const
The MultiApp Level.
Definition: MooseApp.h:465
Object is evaluated only once at the beginning of the simulation.
Definition: MooseTypes.h:94
virtual void outputSystemInformation() override
Print system information.
Definition: Console.C:595
bool getLoggingRequested() const
Returns a Boolean indicating whether performance logging is requested in this application.
void setLoggingRequested()
Sets a Boolean indicating that at least one object is requesting performance logging in this applicat...
bool _verbose
Flag for writing detailed time step information.
Definition: Console.h:174
const std::string & name() const
Get the name of the object.
Definition: MooseApp.h:70
bool _allow_changing_sysinfo_flag
A boolean for protecting _system_info_flags from being changed undesirably.
Definition: Console.h:238
bool contains(const std::string &value) const
Contains methods for seeing if a value is in the MultiMooseEnum.
bool _perf_header
State for the performance log header information.
Definition: Console.h:192
bool _solve_log
State for solve performance log.
Definition: Console.h:186
void write(std::string message, bool indent=true)
Write message to screen and/or file.
Definition: Console.C:644
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:171
PerfLog perf_log
Perflog to be used by applications.
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
Definition: MooseObject.h:67
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition: MooseObject.h:122
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:111
bool _perf_log
State for all performance logging.
Definition: Console.h:180
bool wantOutput(const std::string &name, const ExecFlagType &type)
Handles logic for determining if a step should be output.
void writeStreamToFile(bool append=true)
Write the file stream to the file.
Definition: Console.C:377
virtual void initialSetup()
Initialization method.
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
Executioner * getExecutioner()
Retrieve the Executioner for this App.
Definition: MooseApp.h:233
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
Definition: MooseApp.C:841
const unsigned int& Output::interval ( ) const
inherited

Get the output interval.

bool Output::isAdvanced ( )
inherited

Returns true if this object is an AdvancedOutput object.

Definition at line 245 of file Output.C.

246 {
247  return _is_advanced;
248 }
bool _is_advanced
Flag for advanced output testing.
Definition: Output.h:231
bool MooseObject::isParamValid ( const std::string &  name) const
inlineinherited

Test if the supplied parameter is valid.

Parameters
nameThe name of the parameter to test

Definition at line 67 of file MooseObject.h.

Referenced by BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), GeneratedMesh::buildMesh(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), CSVReader::CSVReader(), MultiAppNearestNodeTransfer::execute(), FileOutput::FileOutput(), MultiApp::fillPositions(), MultiAppNearestNodeTransfer::getLocalNodes(), MultiAppNearestNodeTransfer::getNearestNode(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), MooseMesh::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), SolutionAux::initialSetup(), MooseParsedVectorFunction::initialSetup(), initialSetup(), Receiver::initialSetup(), SolutionFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), AdvancedOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), BreakBoundaryOnSubdomain::modify(), MeshExtruder::modify(), MeshSideSet::modify(), AssignElementSubdomainID::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), SubdomainBoundingBox::modify(), EigenExecutionerBase::normalizeSolution(), Output::Output(), Exodus::outputSetup(), PetscOutput::PetscOutput(), Piecewise::Piecewise(), SolutionUserObject::readExodusII(), RenameBlock::RenameBlock(), Piecewise::setData(), SolutionUserObject::SolutionUserObject(), and TimePeriod::TimePeriod().

67 { return _pars.isParamValid(name); }
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:47
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:111
void SetupInterface::jacobianSetup ( )
virtualinherited

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Definition at line 79 of file SetupInterface.C.

80 {
81 }
void Console::meshChanged ( )
overridevirtual

Performs console related printing when the mesh is changed.

Reimplemented from MeshChangedInterface.

Definition at line 627 of file Console.C.

628 {
630  {
631  _console << ConsoleUtils::outputMeshInformation(*_problem_ptr, /*verbose = */ false);
632 
634  if (!output.empty())
635  _console << "Nonlinear System:\n" << output;
636 
638  if (!output.empty())
639  _console << "Auxiliary System:\n" << output;
640  }
641 }
std::string outputNonlinearSystemInformation(FEProblemBase &problem)
Output the Nonlinear system information.
Definition: ConsoleUtils.C:109
std::string outputAuxiliarySystemInformation(FEProblemBase &problem)
Output the Auxiliary system information.
Definition: ConsoleUtils.C:103
virtual void output(const ExecFlagType &type) override
Customizes the order of output for the various components as well as adds additional output such as t...
Definition: Console.C:312
std::string outputMeshInformation(FEProblemBase &problem, bool verbose=true)
Output the mesh information.
Definition: ConsoleUtils.C:59
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:171
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
bool _print_mesh_changed_info
Flag for printing mesh information when the mesh changes.
Definition: Console.h:229
void Console::mooseConsole ( const std::string &  message)
private

Add a message to the output streams.

Parameters
messageThe message to add to the output streams

Any call to this method will write the supplied message to the screen and/or file, following the same restrictions as outputStep.

Calls to this method should be made via OutputWarehouse::mooseConsole so that the output stream buffer is cleaned up correctly. Thus, it is a private method.

Definition at line 664 of file Console.C.

665 {
666  // Write the messages
667  write(message);
668 
669  // Flush the stream to the screen
670  Moose::out << std::flush;
671 }
void write(std::string message, bool indent=true)
Write message to screen and/or file.
Definition: Console.C:644
template<typename... Args>
void MooseObject::mooseDeprecated ( Args &&...  args) const
inlineinherited
template<typename... Args>
void MooseObject::mooseError ( Args &&...  args) const
inlineinherited

Definition at line 80 of file MooseObject.h.

Referenced by FEProblemBase::addInitialCondition(), DiracKernel::addPointWithValidId(), FEProblemBase::addPostprocessor(), MooseMesh::addQuadratureNode(), FEProblemBase::addVectorPostprocessor(), Output::advancedExecuteOn(), AnnularMesh::AnnularMesh(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BicubicSplineFunction::BicubicSplineFunction(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BoundsAux::BoundsAux(), MooseMesh::buildCoarseningMap(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), TiledMesh::buildMesh(), GeneratedMesh::buildMesh(), ImageMesh::buildMesh3D(), MooseMesh::buildRefinementMap(), EigenExecutionerBase::chebyshev(), FEProblemBase::checkCoordinateSystems(), FEProblemBase::checkDependMaterialsHelper(), FEProblemBase::checkDisplacementOrders(), Material::checkExecutionStage(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), SubProblem::checkMatProps(), FEProblemBase::checkProblemIntegrity(), Material::checkStatefulSanity(), FEProblemBase::checkUserObjects(), LibmeshPartitioner::clone(), CompositeFunction::CompositeFunction(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), FEProblemBase::computeResidual(), Material::computeSubdomainProperties(), PenetrationAux::computeValue(), TimeStepper::constrainStep(), AuxKernel::coupledDot(), AuxKernel::coupledDotDu(), DebugResidualAux::DebugResidualAux(), BicubicSplineFunction::derivative(), DGKernel::DGKernel(), SolutionUserObject::discontinuousPointValue(), SolutionUserObject::discontinuousPointValueGradient(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), MooseMesh::errorIfDistributedMesh(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), PerflogDumper::execute(), NodalValueSampler::execute(), MultiAppPostprocessorTransfer::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), FindValueOnLine::execute(), MultiAppInterpolationTransfer::execute(), TimeExtremeValue::execute(), LeastSquaresFit::execute(), FEProblemBase::executeControls(), FileOutput::FileOutput(), MultiApp::fillPositions(), VerifyElementUniqueID::finalize(), VerifyNodalUniqueID::finalize(), DiscreteElementUserObject::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), Transfer::find_sys(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FunctionDT::FunctionDT(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GapValueAux::GapValueAux(), GeneratedMesh::GeneratedMesh(), GenericConstantMaterial::GenericConstantMaterial(), GenericFunctionMaterial::GenericFunctionMaterial(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), MooseMesh::getCoarseningMap(), FEProblemBase::getCoordSystem(), PiecewiseConstant::getDirection(), FEProblemBase::getDistribution(), MultiApp::getExecutioner(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), AuxKernel::getMaterialProperty(), AuxKernel::getMaterialPropertyOld(), AuxKernel::getMaterialPropertyOlder(), GeneratedMesh::getMaxInDimension(), AnnularMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMaxShapeFunctions(), GeneratedMesh::getMinInDimension(), AnnularMesh::getMinInDimension(), MooseMesh::getMortarInterface(), MooseMesh::getMortarInterfaceByName(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearSystem(), MooseMesh::getPairedBoundaryMapping(), ImageMesh::GetPixelInfo(), MaterialStdVectorAux::getRealValue(), MooseMesh::getRefinementMap(), FEProblemBase::getSampler(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), MooseMesh::getSubdomainBoundaryIds(), MooseMesh::getSubdomainID(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), FEProblemBase::getUserObjectBase(), NumVars::getValue(), PerformanceData::getValue(), Residual::getValue(), FindValueOnLine::getValueAtPoint(), DisplacedProblem::getVariable(), FEProblemBase::getVariable(), MultiApp::globalAppToLocal(), MooseParsedVectorFunction::gradient(), AdvancedOutput::hasOutputHelper(), CSVTimeSequenceStepper::init(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), MooseMesh::init(), FEProblemBase::init(), NumPicardIterations::initialize(), FullSolveMultiApp::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), Exodus::initialSetup(), SolutionFunction::initialSetup(), SolutionUserObject::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initShowHideLists(), Material::initStatefulProperties(), Function::integral(), IntegratedBC::IntegratedBC(), InterfaceKernel::InterfaceKernel(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), KernelBase::KernelBase(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LinearCombinationFunction::LinearCombinationFunction(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< T >::LineMaterialSamplerBase(), MaterialRealTensorValueAux::MaterialRealTensorValueAux(), MaterialRealVectorValueAux::MaterialRealVectorValueAux(), MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), SubProblem::meshChanged(), MeshExtruder::MeshExtruder(), SideSetsFromPoints::modify(), SideSetsFromNormals::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), AssignElementSubdomainID::modify(), AddAllSideSetsByNormals::modify(), ElementDeleterBase::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), BoundingBoxNodeSet::modify(), OrientedSubdomainBoundingBox::modify(), AddSideSetsFromBoundingBox::modify(), SubdomainBoundingBox::modify(), MultiAppMeshFunctionTransfer::MultiAppMeshFunctionTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), NearestNodeDistanceAux::NearestNodeDistanceAux(), NearestNodeValueAux::NearestNodeValueAux(), NodalBC::NodalBC(), NodalConstraint::NodalConstraint(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalVariableValue::NodalVariableValue(), NumDOFs::NumDOFs(), NumNonlinearIterations::NumNonlinearIterations(), XDA::output(), VTKOutput::output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), outputVectorPostprocessors(), AdvancedOutput::outputVectorPostprocessors(), PiecewiseBilinear::parse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PatternedMesh::PatternedMesh(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMultilinear::PiecewiseMultilinear(), SolutionUserObject::pointValueGradientWrapper(), SolutionUserObject::pointValueWrapper(), LStableDirk2::postStep(), LStableDirk3::postStep(), ImplicitMidpoint::postStep(), ExplicitTVDRK2::postStep(), AStableDirk4::postStep(), LStableDirk4::postStep(), ExplicitRK2::postStep(), Predictor::Predictor(), SolutionUserObject::readExodusII(), SolutionUserObject::readXda(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), RenameBlock::RenameBlock(), ScalarComponentIC::ScalarComponentIC(), BicubicSplineFunction::secondDerivative(), FEProblemBase::setCoordSystem(), Piecewise::setData(), EigenProblem::setEigenproblemType(), Sampler::setNumberOfRequiedRandomSeeds(), Split::setup(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), SideSetsFromNormals::SideSetsFromNormals(), SideSetsFromPoints::SideSetsFromPoints(), SolutionUserObject::SolutionUserObject(), FullSolveMultiApp::solveStep(), UserObject::spatialValue(), SphericalAverage::SphericalAverage(), StitchedMesh::StitchedMesh(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), Constraint::subdomainSetup(), systemInfoFlags(), Terminator::Terminator(), TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), Function::timeDerivative(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), MultiAppCopyTransfer::transfer(), MultiAppMeshFunctionTransfer::transferVariable(), Transient::Transient(), TransientMultiApp::TransientMultiApp(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObject::updateExodusBracketingTimeIndices(), Axisymmetric2D3DSolutionFunction::value(), ValueRangeMarker::ValueRangeMarker(), ValueThresholdMarker::ValueThresholdMarker(), MultiAppTransfer::variableIntegrityCheck(), VariableResidual::VariableResidual(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), VectorOfPostprocessors::VectorOfPostprocessors(), VectorPostprocessorFunction::VectorPostprocessorFunction(), MooseParsedGradFunction::vectorValue(), MooseParsedFunction::vectorValue(), and VolumeHistogram::VolumeHistogram().

81  {
82  std::ostringstream oss;
83  moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
84  std::string msg = oss.str();
85  callMooseErrorRaw(msg, &_app);
86  }
void mooseStreamAll(std::ostringstream &ss)
Definition: MooseError.C:78
void callMooseErrorRaw(std::string &msg, MooseApp *app)
Definition: MooseObject.C:45
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
template<typename... Args>
void MooseObject::mooseInfo ( Args &&...  args) const
inlineinherited

Definition at line 101 of file MooseObject.h.

102  {
103  moose::internal::mooseInfoStream(_console, std::forward<Args>(args)...);
104  }
void mooseInfoStream(S &oss, Args &&...args)
Definition: MooseError.h:145
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
template<typename... Args>
void MooseObject::mooseWarning ( Args &&...  args) const
inlineinherited
const std::string& MooseObject::name ( ) const
inlineinherited

Get the name of the object.

Returns
The name of the object

Definition at line 47 of file MooseObject.h.

Referenced by FEProblemBase::addDistribution(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), FEProblemBase::addInitialCondition(), FEProblemBase::addMarker(), FEProblemBase::addMaterial(), MooseMesh::addMortarInterface(), FEProblemBase::addMultiApp(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), Output::advancedExecuteOn(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), AStableDirk4::AStableDirk4(), Function::average(), FEProblemBase::checkDependMaterialsHelper(), Damper::checkMinDamping(), Material::checkStatefulSanity(), CompositeFunction::CompositeFunction(), Material::computeSubdomainProperties(), AuxKernel::coupledCallback(), AuxKernel::coupledDot(), AuxKernel::coupledDotDu(), MultiApp::createApp(), DGKernel::DGKernel(), AB2PredictorCorrector::estimateTimeError(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppCopyTransfer::execute(), FileOutput::FileOutput(), MultiApp::fillPositions(), PointSamplerBase::finalize(), GeneralUserObject::GeneralUserObject(), MultiApp::getBoundingBox(), Control::getControllableParameterHelper(), Control::getControllableValue(), AuxKernel::getDependObjects(), MultiApp::getExecutioner(), OutputWarehouse::getFileNumbers(), SolutionUserObject::getLocalVarIndex(), AuxKernel::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), AuxKernel::getMaterialPropertyOld(), AuxKernel::getMaterialPropertyOlder(), OutputWarehouse::getOutput(), Transient::getTimeStepperName(), InitialCondition::getUserObject(), AuxKernel::getUserObject(), InitialCondition::getUserObjectByName(), AuxKernel::getUserObjectByName(), AdvancedOutput::hasOutputHelper(), FEProblemBase::init(), CSVReader::initialize(), MultiAppProjectionTransfer::initialSetup(), InitialCondition::initialSetup(), SolutionUserObject::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), Material::initStatefulProperties(), Function::integral(), IntegratedBC::IntegratedBC(), InterfaceKernel::InterfaceKernel(), KernelBase::KernelBase(), LinearCombinationFunction::LinearCombinationFunction(), Marker::Marker(), MaterialDerivativeTestKernelBase< T >::MaterialDerivativeTestKernelBase(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), ElementDeleterBase::modify(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), NodalVariableValue::NodalVariableValue(), DOFMapOutput::output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), ConsoleUtils::outputOutputInformation(), Nemesis::outputPostprocessors(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), MooseObject::parameters(), Executioner::parentOutputPositionChanged(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PointSamplerBase::PointSamplerBase(), SubProblem::registerRecoverableData(), SubProblem::registerRestartableData(), Material::resetQpProperties(), Sampler::Sampler(), ScalarComponentIC::ScalarComponentIC(), MooseMesh::setBoundaryName(), Control::setControllableValue(), OutputWarehouse::setFileNumbers(), MooseMesh::setSubdomainName(), Split::setup(), TransientMultiApp::setupApp(), SideValueSampler::SideValueSampler(), TransientMultiApp::solveStep(), UserObject::spatialValue(), SphericalAverage::SphericalAverage(), StitchedMesh::StitchedMesh(), Function::timeDerivative(), TransientMultiApp::TransientMultiApp(), MultiAppTransfer::variableIntegrityCheck(), VariableResidual::VariableResidual(), and AdvancedOutput::wantOutput().

47 { return _name; }
const std::string & _name
The name of this object, reference to value stored in InputParameters.
Definition: MooseObject.h:114
bool Output::onInterval ( )
protectedvirtualinherited

Returns true if the output interval is satisfied.

Definition at line 175 of file Output.C.

Referenced by output(), OversampleOutput::outputStep(), and Output::outputStep().

176 {
177  // The output flag to return
178  bool output = false;
179 
180  // Return true if the current step on the current output interval and within the output time range
181  if (_time >= _start_time && _time <= _end_time && (_t_step % _interval) == 0)
182  output = true;
183 
184  // Return false if 'sync_only' is set to true
185  if (_sync_only)
186  output = false;
187 
188  // If sync times are not skipped, return true if the current time is a sync_time
189  if (_sync_times.find(_time) != _sync_times.end())
190  output = true;
191 
192  // Return the output status
193  return output;
194 }
virtual void output(const ExecFlagType &type)=0
Overload this function with the desired output activities.
Real _start_time
Start outputting time.
Definition: Output.h:213
int & _t_step
The current time step.
Definition: Output.h:195
const unsigned int _interval
The output time step interval.
Definition: Output.h:207
bool _sync_only
Flag for only executing at sync times.
Definition: Output.h:222
std::set< Real > _sync_times
Sync times for this outputter.
Definition: Output.h:210
Real _end_time
End outputting time.
Definition: Output.h:216
Real & _time
The current time for output purposes.
Definition: Output.h:189
void Console::output ( const ExecFlagType type)
overridevirtual

Customizes the order of output for the various components as well as adds additional output such as timestep information and nonlinear/linear residual information.

This method explicitly re-implements portions of AdvancedOutput::output, which is generally not recommended. This is done here to get the output ordering desired. If additional output types (e.g., elemental or nodal) are required in the future this calls will need to be explicitly added as well.

Reimplemented from AdvancedOutput.

Definition at line 312 of file Console.C.

Referenced by meshChanged(), outputSystemInformation(), and writeStreamToFile().

313 {
314  // Return if the current output is not on the desired interval
315  if (type != EXEC_FINAL && !onInterval())
316  return;
317 
318  // Output the system information first; this forces this to be the first item to write by default
319  // However, 'output_system_information_on' still operates correctly, so it may be changed by the
320  // user
321  if (wantOutput("system_information", type) && !(type == EXEC_INITIAL && _initialized))
323 
324  // Write the input
325  if (wantOutput("input", type))
326  outputInput();
327 
328  // Write the timestep information ("Time Step 0 ..."), this is controlled with "execute_on"
332 
333  // Print Non-linear Residual (control with "execute_on")
335  {
336  if (_nonlinear_iter == 0)
337  _old_nonlinear_norm = std::numeric_limits<Real>::max();
338 
339  _console << std::setw(2) << _nonlinear_iter
340  << " Nonlinear |R| = " << outputNorm(_old_nonlinear_norm, _norm) << '\n';
341 
343  }
344 
345  // Print Linear Residual (control with "execute_on")
347  {
348  if (_linear_iter == 0)
349  _old_linear_norm = std::numeric_limits<Real>::max();
350 
351  _console << std::setw(7) << _linear_iter
352  << " Linear |R| = " << outputNorm(_old_linear_norm, _norm) << '\n';
353 
355  }
356 
357  // Write variable norms
358  else if (type == EXEC_TIMESTEP_END)
359  {
361  write(Moose::perf_log.get_perf_info(), false);
363  }
364 
365  // Write Postprocessors and Scalars
366  if (wantOutput("postprocessors", type))
368 
369  if (wantOutput("scalars", type))
371 
372  // Write the file
374 }
Object is evaluated in every residual computation.
Definition: MooseTypes.h:96
MultiMooseEnum _execute_on
The common Execution types; this is used as the default execution type for everything except system i...
Definition: Output.h:186
virtual bool onInterval()
Returns true if the output interval is satisfied.
Definition: Output.C:175
Object is evaluated only once at the beginning of the simulation.
Definition: MooseTypes.h:94
void writeVariableNorms()
Print the L2-norms for each variable.
Definition: Console.C:449
virtual void outputSystemInformation() override
Print system information.
Definition: Console.C:595
int & _t_step
The current time step.
Definition: Output.h:195
Object is evaluated at the end of every time step.
Definition: MooseTypes.h:100
bool contains(const std::string &value) const
Contains methods for seeing if a value is in the MultiMooseEnum.
bool _initialized
True if init() has been called.
Definition: Output.h:225
PetscInt _linear_iter
Current linear iteration returned from PETSc.
Definition: PetscOutput.h:57
virtual void outputPostprocessors() override
Prints the postprocessor table to the screen.
Definition: Console.C:562
void write(std::string message, bool indent=true)
Write message to screen and/or file.
Definition: Console.C:644
unsigned int _perf_log_interval
The interval at which the performance log is printed.
Definition: Console.h:183
PerfLog perf_log
Perflog to be used by applications.
virtual void outputInput() override
Print the input file at the beginning of the simulation.
Definition: Console.C:549
virtual void outputScalarVariables() override
Prints the aux scalar variables table to the screen.
Definition: Console.C:577
Real _norm
Current norm returned from PETSc.
Definition: PetscOutput.h:51
Real _old_nonlinear_norm
Storage for the old non linear residual (needed for color output and only when used when printing to ...
Definition: Console.h:226
bool wantOutput(const std::string &name, const ExecFlagType &type)
Handles logic for determining if a step should be output.
void writeStreamToFile(bool append=true)
Write the file stream to the file.
Definition: Console.C:377
MatType type
Real _old_linear_norm
Storage for the old linear residual (needed for color output and only when used when printing to the ...
Definition: Console.h:223
Object is evaluated at the end of the simulations (output only)
Definition: MooseTypes.h:104
Object is evaluated at the beginning of every time step.
Definition: MooseTypes.h:102
void writeTimestepInformation()
Prints the time step information for the screen output.
Definition: Console.C:401
Object is evaluated in every jacobian computation.
Definition: MooseTypes.h:98
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
std::string outputNorm(const Real &old_norm, const Real &norm)
A helper function for outputting norms in color.
Definition: Console.C:531
PetscInt _nonlinear_iter
Current non-linear iteration returned from PETSc.
Definition: PetscOutput.h:54
void AdvancedOutput::outputElementalVariables ( )
protectedvirtualinherited

Performs output of elemental nonlinear variables The child class must define this method to output the nonlinear variables as desired.

See also
Exodus::outputElementalVariables

Reimplemented in Exodus.

Definition at line 192 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

193 {
194  mooseError(
195  "Individual output of elemental variables is not support for this output object named '",
196  name(),
197  "'");
198 }
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:47
void mooseError(Args &&...args) const
Definition: MooseObject.h:80
void Console::outputInput ( )
overrideprotectedvirtual

Print the input file at the beginning of the simulation.

Reimplemented from AdvancedOutput.

Definition at line 549 of file Console.C.

Referenced by output(), and systemInfoFlags().

550 {
551  if (!_write_screen && !_write_file)
552  return;
553 
554  std::ostringstream oss;
555  oss << "--- " << _app.getInputFileName()
556  << " ------------------------------------------------------";
558  _console << oss.str() << '\n';
559 }
bool _write_screen
Flag for controlling outputting console information to screen.
Definition: Console.h:171
void printInputFile(std::ostream &out)
This method uses the Actions in the warehouse to reproduce the input file.
ActionWarehouse & actionWarehouse()
Definition: MooseApp.h:130
bool _write_file
Flag for controlling outputting console information to a file.
Definition: Console.h:168
std::string getInputFileName()
Returns the input file name that was set with setInputFileName.
Definition: MooseApp.h:144
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
void AdvancedOutput::outputNodalVariables ( )
protectedvirtualinherited

Performs output of nodal nonlinear variables The child class must define this method to output the nonlinear variables as desired.

See also
Exodus::outputNodalVariables

Reimplemented in Exodus.

Definition at line 184 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

185 {
186  mooseError("Individual output of nodal variables is not support for the output object named '",
187  name(),
188  "'");
189 }
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:47
void mooseError(Args &&...args) const
Definition: MooseObject.h:80
std::string Console::outputNorm ( const Real &  old_norm,
const Real &  norm 
)
protected

A helper function for outputting norms in color.

Parameters
old_normThe old residual norm to compare against
normThe current residual norm

Definition at line 531 of file Console.C.

Referenced by output(), and outputVectorPostprocessors().

532 {
533  std::string color = COLOR_GREEN;
534 
535  // Red if the residual went up... or if the norm is nan
536  if (norm != norm || norm > old_norm)
537  color = COLOR_RED;
538  // Yellow if change is less than 5%
539  else if ((old_norm - norm) / old_norm <= 0.05)
540  color = COLOR_YELLOW;
541 
542  std::stringstream oss;
543  oss << std::scientific << color << norm << COLOR_DEFAULT;
544 
545  return oss.str();
546 }
void Console::outputPostprocessors ( )
overrideprotectedvirtual

Prints the postprocessor table to the screen.

Reimplemented from TableOutput.

Definition at line 562 of file Console.C.

Referenced by output(), and systemInfoFlags().

563 {
565 
567  {
568  std::stringstream oss;
569  oss << "\nPostprocessor Values:\n";
572  _console << oss.str() << '\n';
573  }
574 }
bool empty() const
Returns a boolean value based on whether the FormattedTable contains data or not. ...
MooseEnum _fit_mode
The FormattedTable fit mode.
Definition: Console.h:162
FormattedTable & _postprocessor_table
Table containing postprocessor data.
Definition: TableOutput.h:70
unsigned int _max_rows
The max number of table rows.
Definition: Console.h:159
virtual void outputPostprocessors() override
Populates the tables with postprocessor values.
Definition: TableOutput.C:81
void printTable(std::ostream &out, unsigned int last_n_entries=0)
Methods for dumping the table to the stream - either by filename or by stream handle.
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
void sortColumns()
Sorts columns alphabetically.
void Console::outputScalarVariables ( )
overrideprotectedvirtual

Prints the aux scalar variables table to the screen.

Reimplemented from TableOutput.

Definition at line 577 of file Console.C.

Referenced by output(), and systemInfoFlags().

578 {
580 
581  if (!_scalar_table.empty())
582  {
583  std::stringstream oss;
584  oss << "\nScalar Variable Values:\n";
585  if (processor_id() == 0)
586  {
589  }
590  _console << oss.str() << '\n';
591  }
592 }
bool empty() const
Returns a boolean value based on whether the FormattedTable contains data or not. ...
MooseEnum _fit_mode
The FormattedTable fit mode.
Definition: Console.h:162
FormattedTable & _scalar_table
Table containing scalar aux variables.
Definition: TableOutput.h:79
unsigned int _max_rows
The max number of table rows.
Definition: Console.h:159
void printTable(std::ostream &out, unsigned int last_n_entries=0)
Methods for dumping the table to the stream - either by filename or by stream handle.
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
void sortColumns()
Sorts columns alphabetically.
virtual void outputScalarVariables() override
Populates the tables with scalar aux variables.
Definition: TableOutput.C:137
void Output::outputStep ( const ExecFlagType type)
virtualinherited

A single call to this function should output all the necessary data for a single timestep.

Parameters
typeThe type execution flag (see Moose.h)
See also
outputNodalVariables outputElementalVariables outputScalarVariables outputPostprocessors

Reimplemented in OversampleOutput.

Definition at line 144 of file Output.C.

Referenced by PetscOutput::petscLinearOutput(), and PetscOutput::petscNonlinearOutput().

145 {
146  // Output is not allowed
147  if (!_allow_output && type != EXEC_FORCED)
148  return;
149 
150  // If recovering disable output of initial condition, it was already output
151  if (type == EXEC_INITIAL && _app.isRecovering())
152  return;
153 
154  // Return if the current output is not on the desired interval
155  if (type != EXEC_FINAL && !onInterval())
156  return;
157 
158  // Call the output method
159  if (shouldOutput(type))
160  output(type);
161 }
bool isRecovering() const
Whether or not this is a "recover" calculation.
Definition: MooseApp.C:608
virtual bool onInterval()
Returns true if the output interval is satisfied.
Definition: Output.C:175
Object is evaluated only once at the beginning of the simulation.
Definition: MooseTypes.h:94
virtual void output(const ExecFlagType &type)=0
Overload this function with the desired output activities.
virtual bool shouldOutput(const ExecFlagType &type)
Handles logic for determining if a step should be output.
Definition: Output.C:164
Forces execution to occur (output only)
Definition: MooseTypes.h:106
bool _allow_output
Flag for disabling output.
Definition: Output.h:228
MatType type
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
Object is evaluated at the end of the simulations (output only)
Definition: MooseTypes.h:104
void Console::outputSystemInformation ( )
overrideprotectedvirtual

Print system information.

Reimplemented from AdvancedOutput.

Definition at line 595 of file Console.C.

Referenced by initialSetup(), output(), and outputVectorPostprocessors().

596 {
597  if (_system_info_flags.contains("framework"))
599 
600  if (_system_info_flags.contains("mesh"))
602 
603  if (_system_info_flags.contains("nonlinear"))
604  {
606  if (!output.empty())
607  _console << "Nonlinear System:\n" << output;
608  }
609 
610  if (_system_info_flags.contains("aux"))
611  {
613  if (!output.empty())
614  _console << "Auxiliary System:\n" << output;
615  }
616 
617  if (_system_info_flags.contains("execution"))
619 
620  if (_system_info_flags.contains("output"))
622 
623  _console << "\n\n";
624 }
std::string outputNonlinearSystemInformation(FEProblemBase &problem)
Output the Nonlinear system information.
Definition: ConsoleUtils.C:109
std::string outputAuxiliarySystemInformation(FEProblemBase &problem)
Output the Auxiliary system information.
Definition: ConsoleUtils.C:103
std::string outputOutputInformation(MooseApp &app)
Output the output information.
Definition: ConsoleUtils.C:240
bool contains(const std::string &value) const
Contains methods for seeing if a value is in the MultiMooseEnum.
virtual void output(const ExecFlagType &type) override
Customizes the order of output for the various components as well as adds additional output such as t...
Definition: Console.C:312
std::string outputMeshInformation(FEProblemBase &problem, bool verbose=true)
Output the mesh information.
Definition: ConsoleUtils.C:59
MultiMooseEnum _system_info_flags
Flags for controlling the what simulations information is shown.
Definition: Console.h:232
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:171
std::string outputExecutionInformation(MooseApp &app, FEProblemBase &problem)
Output execution information.
Definition: ConsoleUtils.C:212
std::string outputFrameworkInformation(MooseApp &app)
Outputs framework information.
Definition: ConsoleUtils.C:40
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
virtual void Console::outputVectorPostprocessors ( )
inlineoverrideprotectedvirtual

Not implemented.

Reimplemented from TableOutput.

Definition at line 114 of file Console.h.

115  {
116  mooseError("Can't currently output VectorPostprocessors to the screen");
117  };
void mooseError(Args &&...args) const
Definition: MooseObject.h:80
const InputParameters& MooseObject::parameters ( ) const
inlineinherited
void Console::petscSetupOutput ( )
static

Output string for setting up PETSC output.

Definition at line 674 of file Console.C.

Referenced by Moose::PetscSupport::petscSetupOutput().

675 {
676  char c[] = {
677  32, 47, 94, 92, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
678  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
679  32, 32, 32, 32, 32, 32, 32, 47, 94, 92, 13, 10, 124, 32, 32, 32, 92, 95, 47,
680  94, 92, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
681  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 94, 92, 95, 47,
682  32, 32, 32, 124, 13, 10, 124, 32, 32, 32, 32, 32, 32, 32, 32, 92, 95, 47, 94,
683  92, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
684  32, 32, 32, 47, 94, 92, 95, 47, 32, 32, 32, 32, 32, 32, 32, 32, 124, 13, 10,
685  32, 92, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 92, 95, 47, 94, 92,
686  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 94, 92, 95, 47, 32, 32, 32,
687  32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 13, 10, 32, 32, 92, 95, 95, 32, 32,
688  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 92, 95, 95, 95, 45, 45, 45,
689  95, 95, 95, 47, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 95,
690  95, 47, 13, 10, 32, 32, 32, 32, 32, 45, 45, 45, 95, 95, 95, 32, 32, 32, 32,
691  32, 32, 32, 32, 32, 47, 32, 32, 32, 32, 32, 32, 32, 92, 32, 32, 32, 32, 32,
692  32, 32, 32, 32, 95, 95, 95, 45, 45, 45, 13, 10, 32, 32, 32, 32, 32, 32, 32,
693  32, 32, 32, 32, 45, 45, 45, 95, 95, 95, 32, 32, 124, 32, 32, 32, 32, 32, 32,
694  32, 32, 32, 124, 32, 32, 95, 95, 95, 45, 45, 45, 13, 10, 32, 32, 32, 32, 32,
695  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 45, 45, 124, 32, 32, 95, 32,
696  32, 32, 95, 32, 32, 124, 45, 45, 13, 10, 32, 32, 32, 32, 32, 32, 32, 32, 32,
697  32, 32, 32, 32, 32, 32, 32, 32, 32, 124, 32, 32, 124, 111, 124, 32, 124, 111, 124,
698  32, 32, 124, 13, 10, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
699  32, 32, 32, 47, 32, 32, 32, 32, 45, 32, 32, 32, 45, 32, 32, 32, 32, 92, 13,
700  10, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 124, 32,
701  32, 32, 32, 32, 32, 95, 95, 95, 32, 32, 32, 32, 32, 32, 124, 13, 10, 32, 32,
702  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 32, 32, 32,
703  45, 45, 32, 32, 32, 45, 45, 32, 32, 32, 32, 32, 92, 13, 10, 32, 32, 32, 32,
704  32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 32, 32, 32, 32, 32, 32, 32,
705  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 92, 13, 10, 32, 32, 32, 32,
706  32, 32, 32, 32, 32, 32, 32, 32, 124, 32, 32, 32, 32, 32, 32, 32, 47, 92, 32,
707  32, 32, 32, 32, 47, 92, 32, 32, 32, 32, 32, 32, 32, 124, 13, 10, 32, 32, 32,
708  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 92, 32, 32, 92, 32, 32, 32, 32, 32,
709  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 47, 13, 10, 32, 32, 32,
710  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 92, 32, 32, 92, 95, 95, 95, 95,
711  95, 95, 95, 95, 95, 95, 95, 95, 32, 47, 32, 32, 47, 92, 13, 10, 32, 32, 32,
712  32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 92, 32, 32, 32, 32, 32, 32,
713  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 92, 13, 10, 32, 32,
714  32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 32, 32, 92, 32, 32, 32, 32,
715  32, 39, 95, 95, 95, 39, 32, 32, 32, 32, 32, 47, 32, 32, 32, 32, 92, 13, 10,
716  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 92, 32, 32, 32, 32, 32, 92, 32,
717  45, 45, 95, 95, 45, 45, 45, 95, 95, 45, 45, 32, 47, 32, 32, 32, 32, 32, 47,
718  92, 13, 10, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 92, 47, 32, 32,
719  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
720  92, 47, 32, 32, 92, 13, 10, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 32,
721  47, 32, 32, 32, 32, 32, 32, 32, 77, 46, 79, 46, 79, 46, 83, 46, 69, 32, 32,
722  32, 32, 32, 32, 32, 92, 32, 32, 32, 92, 13, 10, 32, 32, 32, 32, 32, 32, 32,
723  47, 32, 32, 32, 124, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
724  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 124, 32, 32, 32, 92, 13, 10, 32,
725  32, 32, 32, 32, 32, 124, 32, 32, 32, 32, 124, 45, 45, 45, 45, 45, 45, 45, 45,
726  45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 45, 124, 32,
727  32, 32, 32, 124, 13, 10, 32, 32, 32, 32, 32, 32, 32, 92, 32, 32, 32, 32, 92,
728  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
729  32, 32, 32, 32, 47, 32, 32, 32, 32, 47, 13, 10, 32, 32, 32, 32, 32, 32, 32,
730  32, 32, 92, 92, 32, 92, 95, 92, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
731  32, 32, 32, 32, 32, 32, 32, 32, 47, 95, 47, 32, 47, 47, 13, 10, 32, 32, 32,
732  32, 32, 32, 32, 32, 32, 32, 32, 45, 45, 32, 32, 92, 32, 32, 32, 32, 32, 32,
733  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 47, 32, 32, 45, 45, 13, 10, 32,
734  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 124, 32, 32, 45,
735  45, 45, 95, 95, 95, 95, 95, 45, 45, 45, 32, 32, 124, 13, 10, 32, 32, 32, 32,
736  32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 124, 32, 32, 32, 32, 32, 124,
737  32, 32, 32, 124, 32, 32, 32, 32, 32, 124, 13, 10, 32, 32, 32, 32, 32, 32, 32,
738  32, 32, 32, 32, 32, 32, 32, 32, 32, 124, 32, 32, 32, 32, 32, 124, 32, 32, 32,
739  124, 32, 32, 32, 32, 32, 124, 13, 10, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
740  32, 32, 32, 32, 32, 47, 32, 86, 32, 32, 32, 32, 32, 92, 32, 47, 32, 32, 32,
741  32, 86, 32, 32, 92, 13, 10, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32, 32,
742  32, 32, 32, 124, 95, 124, 95, 95, 95, 95, 95, 124, 32, 124, 95, 95, 95, 95, 124,
743  95, 95, 124};
744  Moose::out << std::string(c) << std::endl << std::endl;
745 }
void SetupInterface::residualSetup ( )
virtualinherited

Gets called just before the residual is computed and before this object is asked to do its job.

Definition at line 84 of file SetupInterface.C.

85 {
86 }
void FileOutput::setFileNumber ( unsigned int  num)
inherited

Sets the file number manually.

This method was implemented for the MultiApp system, particularly when reseting an application and a new output file is desired after the reset.

Definition at line 176 of file FileOutput.C.

Referenced by OutputWarehouse::setFileNumbers().

177 {
178  _file_num = num;
179 }
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:90
bool AdvancedOutput::shouldOutput ( const ExecFlagType type)
protectedvirtualinherited

Handles logic for determining if a step should be output.

Returns
True if a call if output should be preformed

Reimplemented from FileOutput.

Definition at line 240 of file AdvancedOutput.C.

Referenced by Nemesis::output(), and OversampleOutput::outputStep().

241 {
242  if (!checkFilename())
243  return false;
244 
245  if (hasOutput(type))
246  return true;
247  else
248  return Output::shouldOutput(type);
249 }
virtual bool hasOutput()
Returns true if any of the other has methods return true.
virtual bool shouldOutput(const ExecFlagType &type)
Handles logic for determining if a step should be output.
Definition: Output.C:164
MatType type
bool checkFilename()
Checks the filename for output Checks the output against the &#39;output_if_base_contians&#39; list...
Definition: FileOutput.C:145
void SetupInterface::subdomainSetup ( )
virtualinherited

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented in Material, Constraint, GeneralUserObject, and NodalUserObject.

Definition at line 89 of file SetupInterface.C.

90 {
91 }
MultiMooseEnum& Console::systemInfoFlags ( )
inline

Return system information flags.

Definition at line 82 of file Console.h.

83  {
85  mooseError(
86  "accessing console system information flags is not allowed after console initial setup");
87  return _system_info_flags;
88  }
bool _allow_changing_sysinfo_flag
A boolean for protecting _system_info_flags from being changed undesirably.
Definition: Console.h:238
MultiMooseEnum _system_info_flags
Flags for controlling the what simulations information is shown.
Definition: Console.h:232
void mooseError(Args &&...args) const
Definition: MooseObject.h:80
Real PetscOutput::time ( )
overridevirtualinherited

Get the output time.

This outputter enables the ability to perform output on the nonlinear and linear iterations performed by PETSc. To separate theses outputs within the output a pseudo time is defined, this function provides this time and it should be used in place of _time from Outputter.

Reimplemented from Output.

Definition at line 258 of file PetscOutput.C.

Referenced by FileOutput::FileOutput(), Tecplot::output(), Nemesis::output(), Exodus::outputEmptyTimestep(), Exodus::outputNodalVariables(), TableOutput::outputPostprocessors(), TableOutput::outputScalarVariables(), and writeTimestepInformation().

259 {
261  return _nonlinear_time;
262  else if (_on_linear_residual)
263  return _linear_time;
264  else
265  return Output::time();
266 }
bool _on_linear_residual
True if current output calls is on the linear residual (used by time())
Definition: PetscOutput.h:94
Real _linear_time
Psuedo linear time.
Definition: PetscOutput.h:88
bool _on_nonlinear_residual
True if current output call is on the non-linear residual (used by time())
Definition: PetscOutput.h:97
Real _nonlinear_time
The psuedo non-linear time.
Definition: PetscOutput.h:82
virtual Real time()
Get the output time.
Definition: Output.C:197
Real Output::timeOld ( )
virtualinherited

Get the old output time.

Returns
The old output time, which may be different than the simulation time
See also
time()

Definition at line 206 of file Output.C.

Referenced by writeTimestepInformation().

207 {
208  if (_transient)
209  return _time_old;
210  else
211  return _t_step - 1;
212 }
Real & _time_old
The old time.
Definition: Output.h:192
int & _t_step
The current time step.
Definition: Output.h:195
bool _transient
Transient flag (true = transient)
Definition: Output.h:174
int Output::timeStep ( )
virtualinherited

Get the current time step.

Definition at line 233 of file Output.C.

Referenced by Checkpoint::filename(), CSV::output(), and writeTimestepInformation().

234 {
235  return _t_step;
236 }
int & _t_step
The current time step.
Definition: Output.h:195
void SetupInterface::timestepSetup ( )
virtualinherited

Gets called at the beginning of the timestep before this object is asked to do its job.

Reimplemented in SolutionUserObject, NumNonlinearIterations, and MemoryUsage.

Definition at line 74 of file SetupInterface.C.

75 {
76 }
void Console::write ( std::string  message,
bool  indent = true 
)
protected

Write message to screen and/or file.

Parameters
messageThe desired message
indentTrue if multiapp indenting is desired

Definition at line 644 of file Console.C.

Referenced by initialSetup(), mooseConsole(), output(), outputVectorPostprocessors(), and ~Console().

645 {
646  // Do nothing if the message is empty, writing empty strings messes with multiapp indenting
647  if (message.empty())
648  return;
649 
650  // Write the message to file
651  if (_write_file)
652  _file_output_stream << message;
653 
654  // Apply MultiApp indenting
655  if (indent && _app.multiAppLevel() > 0)
656  MooseUtils::indentMessage(_app.name(), message);
657 
658  // Write message to the screen
659  if (_write_screen)
660  Moose::out << message;
661 }
std::string indent(unsigned int spaces)
Create empty string for indenting.
Definition: ConsoleUtils.C:34
unsigned int multiAppLevel() const
The MultiApp Level.
Definition: MooseApp.h:465
void indentMessage(const std::string &prefix, std::string &message, const char *color=COLOR_CYAN)
Indents the supplied message given the prefix and color.
Definition: MooseUtils.C:438
bool _write_screen
Flag for controlling outputting console information to screen.
Definition: Console.h:171
const std::string & name() const
Get the name of the object.
Definition: MooseApp.h:70
std::stringstream _file_output_stream
Stream for storing information to be written to a file.
Definition: Console.h:177
bool _write_file
Flag for controlling outputting console information to a file.
Definition: Console.h:168
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:108
void Console::writeStreamToFile ( bool  append = true)
protected

Write the file stream to the file.

Parameters
appendToggle for appending the file

This helper function writes the _file_output_stream to the file and clears the stream, by default the file is appended. This does nothing if 'output_file' is false.

Definition at line 377 of file Console.C.

Referenced by initialSetup(), output(), outputVectorPostprocessors(), and ~Console().

378 {
379  if (!_write_file)
380  return;
381 
382  // Create the stream
383  std::ofstream output;
384 
385  // Open the file
386  if (append)
387  output.open(filename().c_str(), std::ios::app | std::ios::out);
388  else
389  output.open(filename().c_str(), std::ios::trunc);
390 
391  std::string s = _file_output_stream.str();
392  // Write contents of file output stream and close the file
393  output << MooseUtils::removeColor(s);
394  output.close();
395 
396  // Clear the file output stream
397  _file_output_stream.str("");
398 }
virtual void output(const ExecFlagType &type) override
Customizes the order of output for the various components as well as adds additional output such as t...
Definition: Console.C:312
virtual std::string filename() override
Creates the output file name Appends the user-supplied &#39;file_base&#39; input parameter with a &#39;...
Definition: Console.C:306
std::stringstream _file_output_stream
Stream for storing information to be written to a file.
Definition: Console.h:177
std::string & removeColor(std::string &msg)
remove ANSI escape sequences for teminal color from msg
Definition: MooseUtils.C:430
bool _write_file
Flag for controlling outputting console information to a file.
Definition: Console.h:168
void Console::writeTimestepInformation ( )
protected

Prints the time step information for the screen output.

Definition at line 401 of file Console.C.

Referenced by output(), and outputVectorPostprocessors().

402 {
403  // Stream to build the time step information
404  std::stringstream oss;
405 
406  // Write timestep data for transient executioners
407  if (_transient)
408  {
409  // Get the length of the time step string
410  std::ostringstream time_step_string;
411  time_step_string << timeStep();
412  unsigned int n = time_step_string.str().size();
413  if (n < 2)
414  n = 2;
415 
416  // Write time step and time information
417  oss << std::endl << "Time Step " << std::setw(n) << timeStep();
418 
419  // Set precision
420  if (_precision > 0)
421  oss << std::setw(_precision) << std::setprecision(_precision) << std::setfill('0')
422  << std::showpoint;
423 
424  // Show scientific notation
425  if (_scientific_time)
426  oss << std::scientific;
427 
428  // Print the time
429  oss << ", time = " << time() << std::endl;
430 
431  // Show old time information, if desired
432  if (_verbose)
433  oss << std::right << std::setw(21) << std::setfill(' ') << "old time = " << std::left
434  << timeOld() << '\n';
435 
436  // Show the time delta information
437  oss << std::right << std::setw(21) << std::setfill(' ') << "dt = " << std::left << dt() << '\n';
438 
439  // Show the old time delta information, if desired
440  if (_verbose)
441  oss << std::right << std::setw(21) << std::setfill(' ') << "old dt = " << _dt_old << '\n';
442  }
443 
444  // Output to the screen
445  _console << oss.str();
446 }
unsigned int _precision
Number of significant digits.
Definition: Console.h:204
virtual Real dt()
Get the current time step size.
Definition: Output.C:215
Real & _dt_old
Old time step delta.
Definition: Output.h:201
virtual Real time() override
Get the output time.
Definition: PetscOutput.C:258
bool _verbose
Flag for writing detailed time step information.
Definition: Console.h:174
bool _transient
Transient flag (true = transient)
Definition: Output.h:174
virtual Real timeOld()
Get the old output time.
Definition: Output.C:206
PetscInt n
bool _scientific_time
Toggle for outputting time in time and dt in scientific notation.
Definition: Console.h:165
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
virtual int timeStep()
Get the current time step.
Definition: Output.C:233
void Console::writeVariableNorms ( )
protected

Print the L2-norms for each variable.

Definition at line 449 of file Console.C.

Referenced by output(), and outputVectorPostprocessors().

450 {
451  // If all_variable_norms is true, then so should outlier printing
454 
455  // if we are not priting anything, let's not waste time computing the norms below and just exit
456  // this call
457  if ((_all_variable_norms == false) && (_outlier_variable_norms == false))
458  return;
459 
460  // if it is an eigenvalue prolblem, we do not know to define RHS,
461  // and then we do not know how to compute variable norms
462  if (dynamic_cast<EigenProblem *>(_problem_ptr) != nullptr)
463  return;
464 
465  // Flag set when header prints
466  bool header = false;
467 
468  // String stream for variable norm information
469  std::ostringstream oss;
470 
471  // Get a references to the NonlinearSystem and libMesh system
473  System & sys = nl.system();
474 
475  // Storage for norm outputs
476  std::map<std::string, Real> other;
477  std::map<std::string, Real> outlier;
478 
479  // Average norm
480  unsigned int n_vars = sys.n_vars();
481  Real avg_norm = (nl.nonlinearNorm() * nl.nonlinearNorm()) / n_vars;
482 
483  // Compute the norms for each of the variables
484  for (unsigned int i = 0; i < n_vars; i++)
485  {
486  // Compute the norm and extract the variable name
487  Real var_norm = sys.calculate_norm(nl.RHS(), i, DISCRETE_L2);
488  var_norm *= var_norm; // use the norm squared
489  std::string var_name = sys.variable_name(i);
490 
491  // Outlier if the variable norm is greater than twice (default) of the average norm
492  if (_outlier_variable_norms && (var_norm > _outlier_multiplier[1] * avg_norm))
493  {
494  // Print the header
495  if (!header)
496  {
497  oss << "\nOutlier Variable Residual Norms:\n";
498  header = true;
499  }
500 
501  // Set the color, RED if the variable norm is 0.8 (default) of the total norm
502  std::string color = COLOR_YELLOW;
503  if (_outlier_variable_norms && (var_norm > _outlier_multiplier[0] * avg_norm * n_vars))
504  color = COLOR_RED;
505 
506  // Display the residual
507  oss << " " << var_name << ": " << std::scientific << color << std::sqrt(var_norm)
508  << COLOR_DEFAULT << '\n';
509  }
510 
511  // GREEN
512  else if (_all_variable_norms)
513  {
514  // Print the header if it doesn't already exist
515  if (!header)
516  {
517  oss << "\nVariable Residual Norms:\n";
518  header = true;
519  }
520  oss << " " << var_name << ": " << std::scientific << COLOR_GREEN << std::sqrt(var_norm)
521  << COLOR_DEFAULT << '\n';
522  }
523  }
524 
525  // Update the output streams
526  _console << oss.str();
527 }
Real nonlinearNorm()
Return the last nonlinear norm.
NonlinearSystemBase & getNonlinearSystemBase()
bool _all_variable_norms
Flag for writing all variable norms.
Definition: Console.h:195
bool _outlier_variable_norms
Flag for writing outlier variable norms.
Definition: Console.h:198
NonlinearSystemBase * nl
Nonlinear system to be solved.
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:171
virtual NumericVector< Number > & RHS()=0
std::vector< Real > _outlier_multiplier
Multipliers for coloring variable residual norms (default [2, 0.8])
Definition: Console.h:201
virtual System & system() override
Get the reference to the libMesh system.
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.

Friends And Related Function Documentation

friend class OutputWarehouse
friend

Definition at line 234 of file Console.h.

Member Data Documentation

OutputOnWarehouse Output::_advanced_execute_on
protectedinherited
FormattedTable& TableOutput::_all_data_table
protectedinherited

Table containing postprocessor values and scalar aux variables.

Definition at line 82 of file TableOutput.h.

Referenced by CSV::initialSetup(), Gnuplot::output(), CSV::output(), TableOutput::outputPostprocessors(), and TableOutput::outputScalarVariables().

bool Console::_all_variable_norms
protected

Flag for writing all variable norms.

Definition at line 195 of file Console.h.

Referenced by writeVariableNorms().

bool Console::_allow_changing_sysinfo_flag
private

A boolean for protecting _system_info_flags from being changed undesirably.

Definition at line 238 of file Console.h.

Referenced by initialSetup(), and systemInfoFlags().

bool Output::_allow_output
protectedinherited

Flag for disabling output.

Definition at line 228 of file Output.h.

Referenced by OversampleOutput::outputStep(), and Output::outputStep().

MooseApp& MooseObject::_app
protectedinherited

The MooseApp this object is associated with.

Definition at line 108 of file MooseObject.h.

Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterial(), FEProblemBase::addMultiApp(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobian(), FEProblemBase::computeResidualType(), Console(), TimeStepper::constrainStep(), MultiApp::createApp(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), InversePowerMethod::execute(), NonlinearEigen::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MooseObject::getMooseApp(), InversePowerMethod::init(), NonlinearEigen::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), InversePowerMethod::InversePowerMethod(), MooseObject::mooseError(), MooseMesh::MooseMesh(), NonlinearEigen::NonlinearEigen(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), SubProblem::registerRecoverableData(), SubProblem::registerRestartableData(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and write().

const ConsoleStream ConsoleStreamInterface::_console
inherited

An instance of helper class to write streams to the Console objects.

Definition at line 37 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), CreateProblemAction::act(), SetupRecoverFileBaseAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), FEProblemBase::advanceMultiApps(), SimplePredictor::apply(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualType(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), AB2PredictorCorrector::converged(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppCopyTransfer::execute(), Steady::execute(), MultiAppDTKUserObjectTransfer::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), MultiApp::globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), outputInput(), outputPostprocessors(), outputScalarVariables(), outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), Transient::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), FEProblemBase::useFECache(), writeTimestepInformation(), writeVariableNorms(), and FEProblemBase::~FEProblemBase().

const std::ostringstream& Console::_console_buffer
private

Reference to cached messages from calls to _console.

Definition at line 220 of file Console.h.

const ExecFlagType& SetupInterface::_current_execute_flag
protectedinherited

Reference to FEProblemBase.

Definition at line 85 of file SetupInterface.h.

Real& Output::_dt
protectedinherited

Time step delta.

Definition at line 198 of file Output.h.

Referenced by Output::dt(), and PetscOutput::solveSetup().

Real& Output::_dt_old
protectedinherited

Old time step delta.

Definition at line 201 of file Output.h.

Referenced by Output::dtOld(), and writeTimestepInformation().

const bool& MooseObject::_enabled
protectedinherited

Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.

Definition at line 117 of file MooseObject.h.

Referenced by MooseObject::enabled().

Real Output::_end_time
protectedinherited

End outputting time.

Definition at line 216 of file Output.h.

Referenced by Output::onInterval().

EquationSystems* Output::_es_ptr
protectedinherited
std::vector<ExecFlagType> SetupInterface::_exec_flags
protectedinherited

execution flag (when is the object executed/evaluated)

Definition at line 82 of file SetupInterface.h.

Referenced by SetupInterface::execBitFlags(), SetupInterface::execFlags(), and SetupInterface::SetupInterface().

MultiMooseEnum Output::_execute_on
protectedinherited

The common Execution types; this is used as the default execution type for everything except system information and input.

Definition at line 186 of file Output.h.

Referenced by AdvancedOutput::AdvancedOutput(), Console(), Output::executeOn(), initialSetup(), Output::Output(), output(), PetscOutput::PetscOutput(), Output::shouldOutput(), and PetscOutput::solveSetup().

std::string FileOutput::_file_base
protectedinherited
unsigned int& FileOutput::_file_num
protectedinherited
std::stringstream Console::_file_output_stream
protected

Stream for storing information to be written to a file.

Definition at line 177 of file Console.h.

Referenced by write(), and writeStreamToFile().

MooseEnum Console::_fit_mode
protected

The FormattedTable fit mode.

Definition at line 162 of file Console.h.

Referenced by outputPostprocessors(), and outputScalarVariables().

bool Output::_initialized
protectedinherited

True if init() has been called.

Definition at line 225 of file Output.h.

Referenced by AdvancedOutput::hasOutputHelper(), Output::initialSetup(), AdvancedOutput::initialSetup(), and output().

const unsigned int Output::_interval
protectedinherited

The output time step interval.

Definition at line 207 of file Output.h.

Referenced by Output::onInterval().

bool Output::_is_advanced
protectedinherited

Flag for advanced output testing.

Definition at line 231 of file Output.h.

Referenced by AdvancedOutput::AdvancedOutput(), and Output::isAdvanced().

bool Console::_libmesh_log
protected

Control the display libMesh performance log.

Definition at line 189 of file Console.h.

Referenced by initialSetup(), and ~Console().

PetscInt PetscOutput::_linear_iter
protectedinherited

Current linear iteration returned from PETSc.

Definition at line 57 of file PetscOutput.h.

Referenced by output(), and PetscOutput::petscLinearOutput().

unsigned int Console::_max_rows
protected

The max number of table rows.

Definition at line 159 of file Console.h.

Referenced by outputPostprocessors(), and outputScalarVariables().

FEProblemBase& MeshChangedInterface::_mci_feproblem
protectedinherited

Reference to FEProblemBase instance.

Definition at line 47 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

const std::string& MooseObject::_name
protectedinherited
PetscInt PetscOutput::_nonlinear_iter
protectedinherited

Current non-linear iteration returned from PETSc.

Definition at line 54 of file PetscOutput.h.

Referenced by output(), and PetscOutput::petscNonlinearOutput().

Real PetscOutput::_norm
protectedinherited

Current norm returned from PETSc.

Definition at line 51 of file PetscOutput.h.

Referenced by output(), PetscOutput::petscLinearOutput(), and PetscOutput::petscNonlinearOutput().

unsigned int Output::_num
protectedinherited

The number of outputs written.

Definition at line 204 of file Output.h.

Real Console::_old_linear_norm
private

Storage for the old linear residual (needed for color output and only when used when printing to the screen)

Definition at line 223 of file Console.h.

Referenced by output().

Real Console::_old_nonlinear_norm
private

Storage for the old non linear residual (needed for color output and only when used when printing to the screen)

Definition at line 226 of file Console.h.

Referenced by output().

std::vector<Real> Console::_outlier_multiplier
protected

Multipliers for coloring variable residual norms (default [2, 0.8])

Definition at line 201 of file Console.h.

Referenced by writeVariableNorms().

bool Console::_outlier_variable_norms
protected

Flag for writing outlier variable norms.

Definition at line 198 of file Console.h.

Referenced by writeVariableNorms().

std::vector<std::string> FileOutput::_output_if_base_contains
protectedinherited

Storage for 'output_if_base_contains'.

Definition at line 96 of file FileOutput.h.

Referenced by FileOutput::checkFilename().

unsigned int FileOutput::_padding
protectedinherited
const InputParameters& MooseObject::_pars
protectedinherited
bool Console::_perf_header
protected

State for the performance log header information.

Definition at line 192 of file Console.h.

Referenced by initialSetup(), and ~Console().

bool Console::_perf_log
protected

State for all performance logging.

Definition at line 180 of file Console.h.

Referenced by Console(), and initialSetup().

unsigned int Console::_perf_log_interval
protected

The interval at which the performance log is printed.

Definition at line 183 of file Console.h.

Referenced by output().

FormattedTable& TableOutput::_postprocessor_table
protectedinherited

Table containing postprocessor data.

Definition at line 70 of file TableOutput.h.

Referenced by TableOutput::outputPostprocessors(), and outputPostprocessors().

unsigned int Console::_precision
protected

Number of significant digits.

Definition at line 204 of file Console.h.

Referenced by writeTimestepInformation().

bool Console::_print_mesh_changed_info
private

Flag for printing mesh information when the mesh changes.

Definition at line 229 of file Console.h.

Referenced by meshChanged().

FEProblemBase* Output::_problem_ptr
protectedinherited
FormattedTable& TableOutput::_scalar_table
protectedinherited

Table containing scalar aux variables.

Definition at line 79 of file TableOutput.h.

Referenced by TableOutput::outputScalarVariables(), and outputScalarVariables().

bool Console::_scientific_time
protected

Toggle for outputting time in time and dt in scientific notation.

Definition at line 165 of file Console.h.

Referenced by writeTimestepInformation().

bool Output::_sequence
protectedinherited

Flag for forcing call to outputSetup() with every call to output() (restartable)

Definition at line 183 of file Output.h.

bool Console::_solve_log
protected

State for solve performance log.

Definition at line 186 of file Console.h.

Referenced by Console(), initialSetup(), and ~Console().

Real Output::_start_time
protectedinherited

Start outputting time.

Definition at line 213 of file Output.h.

Referenced by Output::onInterval().

bool Output::_sync_only
protectedinherited

Flag for only executing at sync times.

Definition at line 222 of file Output.h.

Referenced by Output::onInterval().

std::set<Real> Output::_sync_times
protectedinherited

Sync times for this outputter.

Definition at line 210 of file Output.h.

Referenced by Output::onInterval().

MultiMooseEnum Console::_system_info_flags
private

Flags for controlling the what simulations information is shown.

Definition at line 232 of file Console.h.

Referenced by Console(), outputSystemInformation(), and systemInfoFlags().

int& Output::_t_step
protectedinherited
Real Output::_t_tol
protectedinherited

Time checking tolerance.

Definition at line 219 of file Output.h.

Referenced by PetscOutput::solveSetup().

bool TableOutput::_tables_restartable
protectedinherited

Flag for allowing all table data to become restartable.

Definition at line 67 of file TableOutput.h.

Real& Output::_time
protectedinherited
bool TableOutput::_time_column
protectedinherited

Enable/disable output of time column for Postprocessors.

Definition at line 88 of file TableOutput.h.

Referenced by TableOutput::outputPostprocessors().

bool TableOutput::_time_data
protectedinherited

Enable/disable VecptorPostprocessor time data file.

Definition at line 85 of file TableOutput.h.

Referenced by CSV::output(), and TableOutput::outputVectorPostprocessors().

Real& Output::_time_old
protectedinherited

The old time.

Definition at line 192 of file Output.h.

Referenced by PetscOutput::solveSetup(), and Output::timeOld().

bool Output::_transient
protectedinherited

Transient flag (true = transient)

Definition at line 174 of file Output.h.

Referenced by Output::dt(), Output::dtOld(), Output::time(), Output::timeOld(), and writeTimestepInformation().

bool Output::_use_displaced
protectedinherited

Flag for using displaced mesh.

Definition at line 177 of file Output.h.

std::map<std::string, FormattedTable> TableOutput::_vector_postprocessor_tables
protectedinherited

Formatted tables for outputting vector postprocessor data. One per VectorPostprocessor.

Definition at line 73 of file TableOutput.h.

Referenced by CSV::output(), and TableOutput::outputVectorPostprocessors().

std::map<std::string, FormattedTable>& TableOutput::_vector_postprocessor_time_tables
protectedinherited

Table for vector postprocessor time data.

Definition at line 76 of file TableOutput.h.

Referenced by CSV::output(), and TableOutput::outputVectorPostprocessors().

bool Console::_verbose
protected

Flag for writing detailed time step information.

Definition at line 174 of file Console.h.

Referenced by initialSetup(), and writeTimestepInformation().

bool Console::_write_file
protected

Flag for controlling outputting console information to a file.

Definition at line 168 of file Console.h.

Referenced by outputInput(), write(), and writeStreamToFile().

bool Console::_write_screen
protected

Flag for controlling outputting console information to screen.

Definition at line 171 of file Console.h.

Referenced by outputInput(), and write().


The documentation for this class was generated from the following files: