https://mooseframework.inl.gov
Loading...
Searching...
No Matches
OutputInterface.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
12// MOOSE includes
13#include "MooseTypes.h"
14
15// C++ includes
16#include <set>
17#include <string>
18
19// Forward declerations
20class InputParameters;
21class MooseApp;
22class OutputWarehouse;
23
24template <typename T>
26
34{
35public:
42 OutputInterface(const InputParameters & parameters, bool build_list = true);
43
44#ifdef MOOSE_KOKKOS_ENABLED
49#endif
50
52
62 void buildOutputHideVariableList(std::set<std::string> variable_names);
63
68 const std::set<OutputName> & getOutputs();
69
70private:
73
76
78 std::set<OutputName> _oi_outputs;
79};
InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Base class for MOOSE-based applications.
Definition MooseApp.h:110
A class to provide an common interface to objects requiring "outputs" option.
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.
static InputParameters validParams()
OutputWarehouse & _oi_output_warehouse
Reference to the OutputWarehouse for populating the Output object hide lists.
void buildOutputHideVariableList(std::set< std::string > variable_names)
Builds hide lists for output objects NOT listed in the 'outputs' parameter.
std::set< OutputName > _oi_outputs
The set of Output object names listed in the 'outputs' parameter.
Class for storing and utilizing output objects.