www.mooseframework.org
OutputInterface.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef OUTPUTINTERFACE_H
16 #define OUTPUTINTERFACE_H
17 
18 // MOOSE includes
19 #include "MooseTypes.h"
20 
21 // C++ includes
22 #include <set>
23 #include <string>
24 
25 // Forward declerations
26 class InputParameters;
27 class MooseApp;
28 class OutputInterface;
29 class OutputWarehouse;
30 
31 template <typename T>
33 
34 template <>
36 
44 {
45 public:
53  OutputInterface(const InputParameters & parameters, bool build_list = true);
54 
64  void buildOutputHideVariableList(std::set<std::string> variable_names);
65 
70  const std::set<OutputName> & getOutputs();
71 
72 private:
75 
78 
80  std::set<OutputName> _oi_outputs;
81 };
82 
83 #endif // OUTPUTINTERFACE_H
OutputWarehouse & _oi_output_warehouse
Reference to the OutputWarehouse for populating the Output object hide lists.
InputParameters validParams< OutputInterface >()
A class to provide an common interface to objects requiring "outputs" option.
Base class for MOOSE-based applications.
Definition: MooseApp.h:58
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
OutputInterface(const InputParameters &parameters, bool build_list=true)
Handles &#39;outputs&#39; parameter for objects that desire control of variable outputs.
InputParameters validParams()
std::set< OutputName > _oi_outputs
The set of Output object names listed in the &#39;outputs&#39; parameter.
void buildOutputHideVariableList(std::set< std::string > variable_names)
Builds hide lists for output objects NOT listed in the &#39;outputs&#39; parameter.
Class for storing and utilizing output objects.
MooseApp & _oi_moose_app
Reference the the MooseApp; neede for access to the OutputWarehouse.
const std::set< OutputName > & getOutputs()
Get the list of output objects that this class is restricted.