https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
OutputData Struct Reference

A structure for storing the various lists that contain the names of the items to be exported. More...

#include <AdvancedOutputUtils.h>

Public Member Functions

void reset ()
 Clear existing sets for re-initialization.
 

Public Attributes

std::set< std::string > available
 A list of all possible outputs.
 
std::set< std::string > show
 User-supplied list of outputs to display.
 
std::set< std::string > hide
 User-supplied list of outputs to hide.
 
std::set< std::string > output
 A list of the outputs to write.
 

Detailed Description

A structure for storing the various lists that contain the names of the items to be exported.

An instance of this struct exists for each of the output types (non-linear variables, scalar variables, postprocessors, etc.)

See also
OutputDataWarehouse

Definition at line 27 of file AdvancedOutputUtils.h.

Member Function Documentation

◆ reset()

void OutputData::reset ( )

Clear existing sets for re-initialization.

Definition at line 16 of file AdvancedOutputUtils.C.

17{
18 available.clear();
19 show.clear();
20 hide.clear();
21 output.clear();
22}
std::set< std::string > show
User-supplied list of outputs to display.
std::set< std::string > available
A list of all possible outputs.
std::set< std::string > output
A list of the outputs to write.
std::set< std::string > hide
User-supplied list of outputs to hide.

Member Data Documentation

◆ available

std::set<std::string> OutputData::available

◆ hide

std::set<std::string> OutputData::hide

User-supplied list of outputs to hide.

Definition at line 36 of file AdvancedOutputUtils.h.

Referenced by AdvancedOutput::init(), AdvancedOutput::initOutputList(), and reset().

◆ output

std::set<std::string> OutputData::output

A list of the outputs to write.

Definition at line 39 of file AdvancedOutputUtils.h.

Referenced by AdvancedOutput::initOutputList(), and reset().

◆ show

std::set<std::string> OutputData::show

User-supplied list of outputs to display.

Definition at line 33 of file AdvancedOutputUtils.h.

Referenced by AdvancedOutput::init(), AdvancedOutput::initOutputList(), and reset().


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