A class to provide an common interface to objects requiring "outputs" option. More...
#include <OutputInterface.h>
Public Member Functions | |
OutputInterface (const InputParameters ¶meters, bool build_list=true) | |
Handles 'outputs' parameter for objects that desire control of variable outputs. More... | |
void | buildOutputHideVariableList (std::set< std::string > variable_names) |
Builds hide lists for output objects NOT listed in the 'outputs' parameter. More... | |
const std::set< OutputName > & | getOutputs () |
Get the list of output objects that this class is restricted. More... | |
Static Public Member Functions | |
static InputParameters | validParams () |
Private Attributes | |
MooseApp & | _oi_moose_app |
Reference the the MooseApp; neede for access to the OutputWarehouse. More... | |
OutputWarehouse & | _oi_output_warehouse |
Reference to the OutputWarehouse for populating the Output object hide lists. More... | |
std::set< OutputName > | _oi_outputs |
The set of Output object names listed in the 'outputs' parameter. More... | |
A class to provide an common interface to objects requiring "outputs" option.
The 'outputs' option, when set restricts the output of the variable(s) associated with this object to only occur on output objects listed.
Definition at line 33 of file OutputInterface.h.
OutputInterface::OutputInterface | ( | const InputParameters & | parameters, |
bool | build_list = true |
||
) |
Handles 'outputs' parameter for objects that desire control of variable outputs.
parameters | The parameters object holding data for the class to use. |
build_list | If false the buildOutputHideVariableList must be called explicitly, this behavior is required for automatic output of material properties |
Definition at line 35 of file OutputInterface.C.
void OutputInterface::buildOutputHideVariableList | ( | std::set< std::string > | variable_names | ) |
Builds hide lists for output objects NOT listed in the 'outputs' parameter.
variable_names | A set of variables for which the 'outputs' parameter controls |
By default this is called by the constructor and passes the block name as the list of variables. This needs to be called explicitly if the build_list flag is set to False in the constructor. The latter cases is needed by the Material object to work correctly with the automatic material output capability.
Definition at line 61 of file OutputInterface.C.
Referenced by ReporterTransferInterface::hideVariableHelper(), and OutputInterface().
const std::set< OutputName > & OutputInterface::getOutputs | ( | ) |
Get the list of output objects that this class is restricted.
Definition at line 94 of file OutputInterface.C.
|
static |
Definition at line 18 of file OutputInterface.C.
Referenced by Postprocessor::validParams(), VectorPostprocessor::validParams(), Indicator::validParams(), MooseVariableBase::validParams(), Marker::validParams(), Reporter::validParams(), and MaterialBase::validParams().
|
private |
Reference the the MooseApp; neede for access to the OutputWarehouse.
Definition at line 66 of file OutputInterface.h.
|
private |
Reference to the OutputWarehouse for populating the Output object hide lists.
Definition at line 69 of file OutputInterface.h.
Referenced by buildOutputHideVariableList().
|
private |
The set of Output object names listed in the 'outputs' parameter.
Definition at line 72 of file OutputInterface.h.
Referenced by buildOutputHideVariableList(), and getOutputs().