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

Class for storing and utilizing output objects. More...

#include <OutputWarehouse.h>

Public Member Functions

 OutputWarehouse (MooseApp &app)
 Class constructor. More...
 
virtual ~OutputWarehouse ()
 
void addOutput (std::shared_ptr< Output > &output)
 Adds an existing output object to the warehouse. More...
 
const std::set< OutputName > & getOutputNames ()
 Get a complete set of all output object names. More...
 
bool hasOutput (const std::string &name) const
 Returns true if the output object exists. More...
 
void meshChanged ()
 Calls the meshChanged method for every output object. More...
 
void buildInterfaceHideVariables (const std::string &output_name, std::set< std::string > &hide)
 Return the list of hidden variables for the given output name. More...
 
void setFileNumbers (std::map< std::string, unsigned int > input, unsigned int offset=0)
 Calls the setFileNumber method for every FileOutput output object. More...
 
std::map< std::string, unsigned int > getFileNumbers ()
 Extracts the file numbers from the output objects. More...
 
void setCommonParameters (InputParameters *params_ptr)
 Stores the common InputParameters object. More...
 
InputParametersgetCommonParameters ()
 Get a reference to the common output parameters. More...
 
std::set< Real > & getSyncTimes ()
 Return the sync times for all objects. More...
 
void checkOutputs (const std::set< OutputName > &names)
 Test that the output names exist. More...
 
template<typename T >
T * getOutput (const OutputName &name)
 Return an Output object by name. More...
 
template<typename T >
std::vector< T * > getOutputs (const std::vector< OutputName > &names)
 Return a vector of objects by names. More...
 
template<typename T >
std::vector< T * > getOutputs () const
 Return a vector of objects of a given type. More...
 
template<typename T >
std::vector< OutputName > getOutputNames ()
 Return a list of output objects with a given type. More...
 
const std::set< std::string > & getReservedNames () const
 Return a set of reserved output names. More...
 
bool isReservedName (const std::string &name)
 Test if the given name is reserved. More...
 
void mooseConsole ()
 Send current output buffer to Console output objects. More...
 
std::ostringstream & consoleBuffer ()
 The buffered messages stream for Console objects. More...
 
void bufferConsoleOutputsBeforeConstruction (bool buffer)
 Set if the outputs to Console before its construction are to be buffered or to screen directly. More...
 
void setLoggingRequested ()
 Sets a Boolean indicating that at least one object is requesting performance logging in this application. More...
 
bool getLoggingRequested () const
 Returns a Boolean indicating whether performance logging is requested in this application. More...
 

Private Member Functions

void outputStep (ExecFlagType type)
 Calls the outputStep method for each output object. More...
 
void forceOutput ()
 Indicates that the next call to outputStep should be forced This is private, users should utilize FEProblemBase::forceOutput() More...
 
void addOutputFilename (const OutFileBase &filename)
 Adds the file name to the list of filenames being output The main function of this object is to test that the same output file does not already exist to protect against output files overwriting each other. More...
 
void initialSetup ()
 Calls the initialSetup function for each of the output objects. More...
 
void timestepSetup ()
 Calls the timestepSetup function for each of the output objects. More...
 
void solveSetup ()
 Calls the timestepSetup function for each of the output objects. More...
 
void jacobianSetup ()
 Calls the jacobianSetup function for each of the output objects. More...
 
void residualSetup ()
 Calls the residualSetup function for each of the output objects. More...
 
void subdomainSetup ()
 Calls the subdomainSetup function for each of the output objects. More...
 
void addInterfaceHideVariables (const std::string &output_name, const std::set< std::string > &variable_names)
 Insert variable names for hiding via the OutoutInterface. More...
 
void setOutputExecutionType (ExecFlagType type)
 Sets the execution flag type. More...
 
void flushConsoleBuffer ()
 If content exists in the buffer, write it. More...
 
void allowOutput (bool state)
 Ability to enable/disable output calls This is private, users should utilize FEProblemBase::allowOutput() More...
 
template<typename T >
void allowOutput (bool state)
 

Private Attributes

std::vector< std::shared_ptr< Output > > _all_ptrs
 We are using std::shared_ptr to handle the cleanup of the pointers at the end of execution. More...
 
MooseApp_app
 MooseApp. More...
 
std::vector< Output * > _all_objects
 All instances of objects (raw pointers) More...
 
bool _buffer_action_console_outputs
 True to buffer console outputs in actions. More...
 
std::map< OutputName, Output * > _object_map
 A map of the output pointers. More...
 
std::set< OutputName > _object_names
 A set of output names. More...
 
std::set< OutFileBase > _file_base_set
 List of object names. More...
 
InputParameters_common_params_ptr
 Pointer to the common InputParameters (. More...
 
std::set< Real > _sync_times
 Sync times for all objects. More...
 
std::string _input_file_name
 Input file name for this output object. More...
 
std::map< OutputName, std::set< AuxVariableName > > _material_output_map
 Map of output name and AuxVariable names to be output (used by auto Material output) More...
 
std::set< AuxVariableName > _all_material_output_variables
 List of all variable created by auto material output. More...
 
std::set< std::string > _reserved
 List of reserved names. More...
 
std::ostringstream _console_buffer
 The stream for holding messages passed to _console prior to Output object construction. More...
 
std::map< std::string, std::set< std::string > > _interface_map
 Storage for variables to hide as prescribed by the object via the OutputInterface. More...
 
ExecFlagType _output_exec_flag
 The current output execution flag. More...
 
bool _force_output
 Flag indicating that next call to outputStep is forced. More...
 
bool _logging_requested
 Indicates that performance logging has been requested by the console or some object (PerformanceData) More...
 

Friends

class FEProblemBase
 
class MaterialOutputAction
 
class OutputInterface
 
class PetscOutput
 

Detailed Description

Class for storing and utilizing output objects.

Definition at line 28 of file OutputWarehouse.h.

Constructor & Destructor Documentation

OutputWarehouse::OutputWarehouse ( MooseApp app)

Class constructor.

Definition at line 28 of file OutputWarehouse.C.

29  : _app(app),
32  _force_output(false),
33  _logging_requested(false)
34 {
35  // Set the reserved names
36  _reserved.insert("none"); // allows 'none' to be used as a keyword in 'outputs' parameter
37  _reserved.insert("all"); // allows 'all' to be used as a keyword in 'outputs' parameter
38 }
bool _buffer_action_console_outputs
True to buffer console outputs in actions.
For use with custom executioners that want to fire objects at a specific time.
Definition: MooseTypes.h:110
std::set< std::string > _reserved
List of reserved names.
ExecFlagType _output_exec_flag
The current output execution flag.
MooseApp & _app
MooseApp.
bool _force_output
Flag indicating that next call to outputStep is forced.
bool _logging_requested
Indicates that performance logging has been requested by the console or some object (PerformanceData)...
OutputWarehouse::~OutputWarehouse ( )
virtual

Definition at line 40 of file OutputWarehouse.C.

41 {
42  // If the output buffer is not empty, it needs to be written
43  if (_console_buffer.str().length())
44  mooseConsole();
45 }
std::ostringstream _console_buffer
The stream for holding messages passed to _console prior to Output object construction.
void mooseConsole()
Send current output buffer to Console output objects.

Member Function Documentation

void OutputWarehouse::addInterfaceHideVariables ( const std::string &  output_name,
const std::set< std::string > &  variable_names 
)
private

Insert variable names for hiding via the OutoutInterface.

Parameters
output_nameThe name of the output object on which the variable is to be hidden
variable_namesThe names of the variables to be hidden

This is a private method used by the OutputInterface system, it is not intended for any other purpose.

Definition at line 268 of file OutputWarehouse.C.

Referenced by MaterialOutputAction::buildMaterialOutputObjects(), and OutputInterface::buildOutputHideVariableList().

270 {
271  _interface_map[output_name].insert(variable_names.begin(), variable_names.end());
272 }
std::map< std::string, std::set< std::string > > _interface_map
Storage for variables to hide as prescribed by the object via the OutputInterface.
void OutputWarehouse::addOutput ( std::shared_ptr< Output > &  output)

Adds an existing output object to the warehouse.

Parameters
outputPointer to the output object It is the responsibility of the OutputWarehouse to delete the output objects add using this method

Definition at line 90 of file OutputWarehouse.C.

Referenced by AddOutputAction::act().

91 {
92  _all_ptrs.push_back(output);
93 
94  // Add the object to the warehouse storage, Checkpoint placed at end so they are called last
95  Checkpoint * cp = dynamic_cast<Checkpoint *>(output.get());
96  if (cp != NULL)
97  _all_objects.push_back(output.get());
98  else
99  _all_objects.insert(_all_objects.begin(), output.get());
100 
101  // Store the name and pointer
102  _object_map[output->name()] = output.get();
103  _object_names.insert(output->name());
104 
105  // If the output object is a FileOutput then store the output filename
106  FileOutput * ptr = dynamic_cast<FileOutput *>(output.get());
107  if (ptr != NULL)
108  addOutputFilename(ptr->filename());
109 
110  // Insert object sync times to the global set
111  if (output->parameters().isParamValid("sync_times"))
112  {
113  std::vector<Real> sync_times = output->parameters().get<std::vector<Real>>("sync_times");
114  _sync_times.insert(sync_times.begin(), sync_times.end());
115  }
116 }
virtual std::string filename()
The filename for the output file.
Definition: FileOutput.C:170
std::map< OutputName, Output * > _object_map
A map of the output pointers.
std::set< OutputName > _object_names
A set of output names.
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void addOutputFilename(const OutFileBase &filename)
Adds the file name to the list of filenames being output The main function of this object is to test ...
std::vector< std::shared_ptr< Output > > _all_ptrs
We are using std::shared_ptr to handle the cleanup of the pointers at the end of execution.
An outputter with filename support.
Definition: FileOutput.h:32
std::set< Real > _sync_times
Sync times for all objects.
void OutputWarehouse::addOutputFilename ( const OutFileBase &  filename)
private

Adds the file name to the list of filenames being output The main function of this object is to test that the same output file does not already exist to protect against output files overwriting each other.

Parameters
filenameName of an output file (extracted from filename() method of the objects)

Definition at line 137 of file OutputWarehouse.C.

Referenced by addOutput().

138 {
139  if (_file_base_set.find(filename) != _file_base_set.end())
140  mooseError("An output file with the name, ", filename, ", already exists.");
141  _file_base_set.insert(filename);
142 }
void mooseError(Args &&...args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:182
std::set< OutFileBase > _file_base_set
List of object names.
void OutputWarehouse::allowOutput ( bool  state)
private

Ability to enable/disable output calls This is private, users should utilize FEProblemBase::allowOutput()

See also
FEProblemBase::allowOutput()

Definition at line 311 of file OutputWarehouse.C.

Referenced by FEProblemBase::allowOutput(), and getLoggingRequested().

312 {
313  for (const auto & obj : _all_objects)
314  obj->allowOutput(state);
315 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
template<typename T >
void OutputWarehouse::allowOutput ( bool  state)
private

Definition at line 445 of file OutputWarehouse.h.

446 {
447  std::vector<T *> outputs = getOutputs<T>();
448  for (typename std::vector<T *>::iterator it = outputs.begin(); it != outputs.end(); ++it)
449  (*it)->allowOutput(state);
450 }
void OutputWarehouse::bufferConsoleOutputsBeforeConstruction ( bool  buffer)
inline

Set if the outputs to Console before its construction are to be buffered or to screen directly.

Parameters
bufferTure to buffer

Definition at line 189 of file OutputWarehouse.h.

190  {
192  }
bool _buffer_action_console_outputs
True to buffer console outputs in actions.
void OutputWarehouse::buildInterfaceHideVariables ( const std::string &  output_name,
std::set< std::string > &  hide 
)

Return the list of hidden variables for the given output name.

Parameters
output_nameThe name of the output object for which the variables should be returned
hideThe set of variables to hide which is built by this method

Objects inheriting from the OutputInterface have the ability to control the output of variables associated with the objects (i.e., Marker elemental variable). This method returns a list of variables that should be hidden for the supplied object name due to the 'outputs' parameter being set by the object(s).

This method is used by Output::initOutputList to populate the correct hide lists for the output object, it is not intended for general use.

Definition at line 275 of file OutputWarehouse.C.

Referenced by AdvancedOutput::initOutputList().

277 {
278  std::map<std::string, std::set<std::string>>::const_iterator it =
279  _interface_map.find(output_name);
280  if (it != _interface_map.end())
281  hide = it->second;
282 }
std::map< std::string, std::set< std::string > > _interface_map
Storage for variables to hide as prescribed by the object via the OutputInterface.
void OutputWarehouse::checkOutputs ( const std::set< OutputName > &  names)

Test that the output names exist.

Parameters
namesA vector of names to check This method will produce an error if any of the supplied names do not exist in the warehouse. Reserved names are not considered.

Definition at line 285 of file OutputWarehouse.C.

Referenced by CheckOutputAction::checkMaterialOutput(), and AdvancedOutput::initPostprocessorOrVectorPostprocessorLists().

286 {
287  for (const auto & name : names)
288  if (!isReservedName(name) && !hasOutput(name))
289  mooseError("The output object '", name, "' is not a defined output object");
290 }
void mooseError(Args &&...args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:182
bool isReservedName(const std::string &name)
Test if the given name is reserved.
bool hasOutput(const std::string &name) const
Returns true if the output object exists.
std::ostringstream& OutputWarehouse::consoleBuffer ( )
inline

The buffered messages stream for Console objects.

Returns
Reference to the stream storing cached messages from calls to _console

Definition at line 183 of file OutputWarehouse.h.

183 { return _console_buffer; }
std::ostringstream _console_buffer
The stream for holding messages passed to _console prior to Output object construction.
void OutputWarehouse::flushConsoleBuffer ( )
private

If content exists in the buffer, write it.

This is used by Console to make sure PETSc related output does not dump before buffered content. It is private because people shouldn't be messing with it.

Definition at line 208 of file OutputWarehouse.C.

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

209 {
210  if (!_console_buffer.str().empty())
211  mooseConsole();
212 }
std::ostringstream _console_buffer
The stream for holding messages passed to _console prior to Output object construction.
void mooseConsole()
Send current output buffer to Console output objects.
void OutputWarehouse::forceOutput ( )
private

Indicates that the next call to outputStep should be forced This is private, users should utilize FEProblemBase::forceOutput()

See also
FEProblemBase::forceOutput()

Definition at line 318 of file OutputWarehouse.C.

Referenced by FEProblemBase::forceOutput(), and getLoggingRequested().

319 {
320  _force_output = true;
321 }
bool _force_output
Flag indicating that next call to outputStep is forced.
InputParameters * OutputWarehouse::getCommonParameters ( )

Get a reference to the common output parameters.

Returns
Pointer to the common InputParameters object

Definition at line 256 of file OutputWarehouse.C.

Referenced by AddOutputAction::act().

257 {
258  return _common_params_ptr;
259 }
InputParameters * _common_params_ptr
Pointer to the common InputParameters (.
std::map< std::string, unsigned int > OutputWarehouse::getFileNumbers ( )

Extracts the file numbers from the output objects.

Returns
Map of file numbers for the output objects

Definition at line 236 of file OutputWarehouse.C.

Referenced by MultiApp::createApp().

237 {
238 
239  std::map<std::string, unsigned int> output;
240  for (const auto & obj : _all_objects)
241  {
242  FileOutput * ptr = dynamic_cast<FileOutput *>(obj);
243  if (ptr != NULL)
244  output[ptr->name()] = ptr->getFileNumber();
245  }
246  return output;
247 }
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:47
unsigned int getFileNumber()
Return the current file number for this outputter.
Definition: FileOutput.C:182
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
An outputter with filename support.
Definition: FileOutput.h:32
bool OutputWarehouse::getLoggingRequested ( ) const
inline

Returns a Boolean indicating whether performance logging is requested in this application.

Definition at line 198 of file OutputWarehouse.h.

Referenced by Console::initialSetup().

198 { return _logging_requested; }
bool _logging_requested
Indicates that performance logging has been requested by the console or some object (PerformanceData)...
template<typename T >
T * OutputWarehouse::getOutput ( const OutputName &  name)

Return an Output object by name.

Template Parameters
TThe Out put object type to return
Parameters
nameThe name of the output object
Returns
A pointer to the output object

Definition at line 369 of file OutputWarehouse.h.

370 {
371  // Check that the object exists
372  if (!hasOutput(name))
373  mooseError("An output object with the name '", name, "' does not exist.");
374 
375  // Attempt to cast the object to the correct type
376  T * output = dynamic_cast<T *>(_object_map[name]);
377 
378  // Error if the cast fails
379  if (output == NULL)
380  mooseError("An output object with the name '", name, "' for the specified type does not exist");
381 
382  // Return the object
383  return output;
384 }
std::map< OutputName, Output * > _object_map
A map of the output pointers.
void mooseError(Args &&...args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:182
bool hasOutput(const std::string &name) const
Returns true if the output object exists.
const std::set< OutputName > & OutputWarehouse::getOutputNames ( )

Get a complete set of all output object names.

Returns
A set of output names for each output object

Note, if this method is called prior to the creation of outputs in AddOutputAction it will create the proxy list of names from the action system. The main use is for the OutputInterface, specifically, when used with Postprocessors in the UserObjects block of the input file. UserObjects are created prior to Outputs objects, but OutputInterface needs the list of output names to operate correctly.

Definition at line 125 of file OutputWarehouse.C.

Referenced by OutputInterface::buildOutputHideVariableList().

126 {
127  if (_object_names.empty())
128  {
129  const auto & actions = _app.actionWarehouse().getActionListByName("add_output");
130  for (const auto & act : actions)
131  _object_names.insert(act->name());
132  }
133  return _object_names;
134 }
std::set< OutputName > _object_names
A set of output names.
const std::list< Action * > & getActionListByName(const std::string &task) const
Retrieve a constant list of Action pointers associated with the passed in task.
MooseApp & _app
MooseApp.
ActionWarehouse & actionWarehouse()
Definition: MooseApp.h:130
template<typename T >
std::vector< OutputName > OutputWarehouse::getOutputNames ( )

Return a list of output objects with a given type.

Template Parameters
TThe output object type
Returns
A vector of names

Definition at line 424 of file OutputWarehouse.h.

425 {
426  // The output vector
427  std::vector<OutputName> names;
428 
429  // Loop through the objects and store the name if the type cast succeeds
430  for (std::map<OutputName, Output *>::const_iterator it = _object_map.begin();
431  it != _object_map.end();
432  ++it)
433  {
434  T * output = dynamic_cast<T *>(it->second);
435  if (output != NULL)
436  names.push_back(it->first);
437  }
438 
439  // Return the names
440  return names;
441 }
std::map< OutputName, Output * > _object_map
A map of the output pointers.
template<typename T >
std::vector< T * > OutputWarehouse::getOutputs ( const std::vector< OutputName > &  names)

Return a vector of objects by names.

Template Parameters
TThe Output object type to return
Parameters
namesA vector of names of the output object
Returns
A pointer to the output object

Definition at line 388 of file OutputWarehouse.h.

Referenced by CheckOutputAction::checkConsoleOutput(), CheckOutputAction::checkPerfLogOutput(), and ConsoleUtils::outputOutputInformation().

389 {
390  // The vector to output
391  std::vector<T *> outputs;
392 
393  // Populate the vector
394  for (std::vector<OutputName>::const_iterator it = names.begin(); it != names.end(); ++it)
395  outputs.push_back(getOutput<T>(*it));
396 
397  // Return the objects
398  return outputs;
399 }
template<typename T >
std::vector< T * > OutputWarehouse::getOutputs ( ) const

Return a vector of objects of a given type.

Template Parameters
TThe Output object type to return
Returns
A pointer to the output object

Definition at line 403 of file OutputWarehouse.h.

404 {
405  // The vector to output
406  std::vector<T *> outputs;
407 
408  // Populate the vector
409  for (std::map<OutputName, Output *>::const_iterator it = _object_map.begin();
410  it != _object_map.end();
411  ++it)
412  {
413  T * output = dynamic_cast<T *>(it->second);
414  if (output != NULL)
415  outputs.push_back(output);
416  }
417 
418  // Return the objects
419  return outputs;
420 }
std::map< OutputName, Output * > _object_map
A map of the output pointers.
const std::set< std::string > & OutputWarehouse::getReservedNames ( ) const

Return a set of reserved output names.

Returns
A std::set of reserved names

Definition at line 293 of file OutputWarehouse.C.

294 {
295  return _reserved;
296 }
std::set< std::string > _reserved
List of reserved names.
std::set< Real > & OutputWarehouse::getSyncTimes ( )

Return the sync times for all objects.

Definition at line 262 of file OutputWarehouse.C.

Referenced by TimePeriod::initialSetup().

263 {
264  return _sync_times;
265 }
std::set< Real > _sync_times
Sync times for all objects.
bool OutputWarehouse::hasOutput ( const std::string &  name) const

Returns true if the output object exists.

Parameters
nameThe name of the output object for which to test for existence within the warehouse

Definition at line 119 of file OutputWarehouse.C.

Referenced by AddOutputAction::act(), checkOutputs(), and getOutput().

120 {
121  return _object_map.find(name) != _object_map.end();
122 }
std::map< OutputName, Output * > _object_map
A map of the output pointers.
void OutputWarehouse::initialSetup ( )
private

Calls the initialSetup function for each of the output objects.

See also
FEProblemBase::initialSetup()

Definition at line 48 of file OutputWarehouse.C.

Referenced by FEProblemBase::initialSetup().

49 {
50  for (const auto & obj : _all_objects)
51  obj->initialSetup();
52 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
bool OutputWarehouse::isReservedName ( const std::string &  name)

Test if the given name is reserved.

Parameters
nameThe name to test
Returns
True if the name is reserved

Definition at line 299 of file OutputWarehouse.C.

Referenced by AddOutputAction::act(), and checkOutputs().

300 {
301  return _reserved.find(name) != _reserved.end();
302 }
std::set< std::string > _reserved
List of reserved names.
void OutputWarehouse::jacobianSetup ( )
private

Calls the jacobianSetup function for each of the output objects.

See also
FEProblemBase::computeJacobian

Definition at line 69 of file OutputWarehouse.C.

Referenced by FEProblemBase::computeJacobian().

70 {
71  for (const auto & obj : _all_objects)
72  obj->jacobianSetup();
73 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void OutputWarehouse::meshChanged ( )

Calls the meshChanged method for every output object.

Definition at line 171 of file OutputWarehouse.C.

Referenced by MooseApp::setOutputPosition().

172 {
173  for (const auto & obj : _all_objects)
174  obj->meshChanged();
175 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void OutputWarehouse::mooseConsole ( )

Send current output buffer to Console output objects.

Definition at line 178 of file OutputWarehouse.C.

Referenced by callMooseErrorRaw(), flushConsoleBuffer(), FEProblemBase::initialSetup(), ConsoleStream::operator<<(), and ~OutputWarehouse().

179 {
180  // Loop through all Console Output objects and pass the current output buffer
181  std::vector<Console *> objects = getOutputs<Console>();
182  if (!objects.empty())
183  {
184  for (const auto & obj : objects)
185  obj->mooseConsole(_console_buffer.str());
186 
187  // Reset
188  _console_buffer.clear();
189  _console_buffer.str("");
190  }
191  else
192  {
194  {
195  // this will cause messages to console before its construction immediately flushed and
196  // cleared.
197  std::string message = _console_buffer.str();
198  if (_app.multiAppLevel() > 0)
199  MooseUtils::indentMessage(_app.name(), message);
200  Moose::out << message << std::flush;
201  _console_buffer.clear();
202  _console_buffer.str("");
203  }
204  }
205 }
bool _buffer_action_console_outputs
True to buffer console outputs in actions.
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
const std::string & name() const
Get the name of the object.
Definition: MooseApp.h:70
MooseApp & _app
MooseApp.
std::ostringstream _console_buffer
The stream for holding messages passed to _console prior to Output object construction.
void OutputWarehouse::outputStep ( ExecFlagType  type)
private

Calls the outputStep method for each output object.

Parameters
typeThe type execution flag (see Moose.h)

This is private, users should utilize FEProblemBase::outputStep()

This is one of three locations where we explicitly flush the output buffers during a simulation: PetscOutput::petscNonlinearOutput() PetscOutput::petscLinearOutput() OutputWarehouse::outputStep()

All other Console output should be using newlines to avoid covering buffer errors and to avoid excessive I/O

Definition at line 145 of file OutputWarehouse.C.

Referenced by getLoggingRequested(), and FEProblemBase::outputStep().

146 {
147  if (_force_output)
148  type = EXEC_FORCED;
149 
150  for (const auto & obj : _all_objects)
151  if (obj->enabled())
152  obj->outputStep(type);
153 
165 
166  // Reset force output flag
167  _force_output = false;
168 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
Forces execution to occur (output only)
Definition: MooseTypes.h:106
bool _force_output
Flag indicating that next call to outputStep is forced.
MatType type
void flushConsoleBuffer()
If content exists in the buffer, write it.
void OutputWarehouse::residualSetup ( )
private

Calls the residualSetup function for each of the output objects.

See also
FEProblemBase::computeResidualTyp

Definition at line 76 of file OutputWarehouse.C.

Referenced by FEProblemBase::computeResidualType().

77 {
78  for (const auto & obj : _all_objects)
79  obj->residualSetup();
80 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void OutputWarehouse::setCommonParameters ( InputParameters params_ptr)

Stores the common InputParameters object.

Parameters
params_ptrA pointer to the common parameters object to be stored
See also
CommonOutputAction

Definition at line 250 of file OutputWarehouse.C.

Referenced by CommonOutputAction::act().

251 {
252  _common_params_ptr = params_ptr;
253 }
InputParameters * _common_params_ptr
Pointer to the common InputParameters (.
void OutputWarehouse::setFileNumbers ( std::map< std::string, unsigned int >  input,
unsigned int  offset = 0 
)

Calls the setFileNumber method for every FileOutput output object.

Definition at line 215 of file OutputWarehouse.C.

216 {
217  for (const auto & obj : _all_objects)
218  {
219  FileOutput * ptr = dynamic_cast<FileOutput *>(obj);
220  if (ptr != NULL)
221  {
222  std::map<std::string, unsigned int>::const_iterator it = input.find(ptr->name());
223  if (it != input.end())
224  {
225  int value = it->second + offset;
226  if (value < 0)
227  ptr->setFileNumber(0);
228  else
229  ptr->setFileNumber(it->second + offset);
230  }
231  }
232  }
233 }
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:47
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void setFileNumber(unsigned int num)
Sets the file number manually.
Definition: FileOutput.C:176
An outputter with filename support.
Definition: FileOutput.h:32
void OutputWarehouse::setLoggingRequested ( )
inline

Sets a Boolean indicating that at least one object is requesting performance logging in this application.

Definition at line 195 of file OutputWarehouse.h.

Referenced by Console::initialSetup(), and PerformanceData::PerformanceData().

195 { _logging_requested = true; }
bool _logging_requested
Indicates that performance logging has been requested by the console or some object (PerformanceData)...
void OutputWarehouse::setOutputExecutionType ( ExecFlagType  type)
private

Sets the execution flag type.

This is a private method used by FEProblemBase, it is not intended for any other purpose

Definition at line 305 of file OutputWarehouse.C.

306 {
308 }
ExecFlagType _output_exec_flag
The current output execution flag.
MatType type
void OutputWarehouse::solveSetup ( )
private

Calls the timestepSetup function for each of the output objects.

See also
FEProblemBase::solve()

Definition at line 62 of file OutputWarehouse.C.

Referenced by FEProblemBase::initPetscOutput().

63 {
64  for (const auto & obj : _all_objects)
65  obj->solveSetup();
66 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void OutputWarehouse::subdomainSetup ( )
private

Calls the subdomainSetup function for each of the output objects.

See also
FEProblemBase::setupSubdomain

Definition at line 83 of file OutputWarehouse.C.

Referenced by FEProblemBase::subdomainSetup().

84 {
85  for (const auto & obj : _all_objects)
86  obj->subdomainSetup();
87 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)
void OutputWarehouse::timestepSetup ( )
private

Calls the timestepSetup function for each of the output objects.

See also
FEProblemBase::timestepSetup()

Definition at line 55 of file OutputWarehouse.C.

Referenced by FEProblemBase::timestepSetup().

56 {
57  for (const auto & obj : _all_objects)
58  obj->timestepSetup();
59 }
std::vector< Output * > _all_objects
All instances of objects (raw pointers)

Friends And Related Function Documentation

friend class FEProblemBase
friend

Definition at line 355 of file OutputWarehouse.h.

friend class MaterialOutputAction
friend

Definition at line 358 of file OutputWarehouse.h.

friend class OutputInterface
friend

Definition at line 361 of file OutputWarehouse.h.

friend class PetscOutput
friend

Definition at line 364 of file OutputWarehouse.h.

Member Data Documentation

std::set<AuxVariableName> OutputWarehouse::_all_material_output_variables
private

List of all variable created by auto material output.

Definition at line 333 of file OutputWarehouse.h.

std::vector<Output *> OutputWarehouse::_all_objects
private
std::vector<std::shared_ptr<Output> > OutputWarehouse::_all_ptrs
private

We are using std::shared_ptr to handle the cleanup of the pointers at the end of execution.

This is necessary since several warehouses might be sharing a single instance of a MooseObject.

Definition at line 231 of file OutputWarehouse.h.

Referenced by addOutput().

MooseApp& OutputWarehouse::_app
private

MooseApp.

Definition at line 303 of file OutputWarehouse.h.

Referenced by getOutputNames(), and mooseConsole().

bool OutputWarehouse::_buffer_action_console_outputs
private

True to buffer console outputs in actions.

Definition at line 309 of file OutputWarehouse.h.

Referenced by bufferConsoleOutputsBeforeConstruction(), and mooseConsole().

InputParameters* OutputWarehouse::_common_params_ptr
private

Pointer to the common InputParameters (.

See also
CommonOutputAction)

Definition at line 321 of file OutputWarehouse.h.

Referenced by getCommonParameters(), and setCommonParameters().

std::ostringstream OutputWarehouse::_console_buffer
private

The stream for holding messages passed to _console prior to Output object construction.

Definition at line 339 of file OutputWarehouse.h.

Referenced by consoleBuffer(), flushConsoleBuffer(), mooseConsole(), and ~OutputWarehouse().

std::set<OutFileBase> OutputWarehouse::_file_base_set
private

List of object names.

Definition at line 318 of file OutputWarehouse.h.

Referenced by addOutputFilename().

bool OutputWarehouse::_force_output
private

Flag indicating that next call to outputStep is forced.

Definition at line 348 of file OutputWarehouse.h.

Referenced by forceOutput(), and outputStep().

std::string OutputWarehouse::_input_file_name
private

Input file name for this output object.

Definition at line 327 of file OutputWarehouse.h.

std::map<std::string, std::set<std::string> > OutputWarehouse::_interface_map
private

Storage for variables to hide as prescribed by the object via the OutputInterface.

Definition at line 342 of file OutputWarehouse.h.

Referenced by addInterfaceHideVariables(), and buildInterfaceHideVariables().

bool OutputWarehouse::_logging_requested
private

Indicates that performance logging has been requested by the console or some object (PerformanceData)

Definition at line 351 of file OutputWarehouse.h.

Referenced by getLoggingRequested(), and setLoggingRequested().

std::map<OutputName, std::set<AuxVariableName> > OutputWarehouse::_material_output_map
private

Map of output name and AuxVariable names to be output (used by auto Material output)

Definition at line 330 of file OutputWarehouse.h.

std::map<OutputName, Output *> OutputWarehouse::_object_map
private

A map of the output pointers.

Definition at line 312 of file OutputWarehouse.h.

Referenced by addOutput(), getOutput(), getOutputNames(), getOutputs(), and hasOutput().

std::set<OutputName> OutputWarehouse::_object_names
private

A set of output names.

Definition at line 315 of file OutputWarehouse.h.

Referenced by addOutput(), and getOutputNames().

ExecFlagType OutputWarehouse::_output_exec_flag
private

The current output execution flag.

Definition at line 345 of file OutputWarehouse.h.

Referenced by setOutputExecutionType().

std::set<std::string> OutputWarehouse::_reserved
private

List of reserved names.

Definition at line 336 of file OutputWarehouse.h.

Referenced by getReservedNames(), isReservedName(), and OutputWarehouse().

std::set<Real> OutputWarehouse::_sync_times
private

Sync times for all objects.

Definition at line 324 of file OutputWarehouse.h.

Referenced by addOutput(), and getSyncTimes().


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