www.mooseframework.org
OutputInterface.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // MOOSE includes
13 #include "MooseTypes.h"
14 
15 // C++ includes
16 #include <set>
17 #include <string>
18 
19 // Forward declerations
20 class InputParameters;
21 class MooseApp;
22 class OutputInterface;
23 class OutputWarehouse;
24 
25 template <typename T>
27 
28 template <>
30 
38 {
39 public:
47  OutputInterface(const InputParameters & parameters, bool build_list = true);
48 
58  void buildOutputHideVariableList(std::set<std::string> variable_names);
59 
64  const std::set<OutputName> & getOutputs();
65 
66 private:
69 
72 
74  std::set<OutputName> _oi_outputs;
75 };
76 
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:59
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()
This is the templated validParams() function that every MooseObject-derived class is required to spec...
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.