OutputOnWarehouse Class Reference

A helper warehouse class for storing the "execute_on" settings for the various output types. More...

#include <AdvancedOutputUtils.h>

Inheritance diagram for OutputOnWarehouse:

Public Member Functions
	OutputOnWarehouse (const ExecFlagEnum &execute_on, const InputParameters &parameters)
	Constructor. More...
ExecFlagEnum &	operator[] (const std::string &name)
	A map accessor that errors if the key is not found. More...
bool	contains (const std::string &name) const
	A method for testing of a key exists. More...
std::map< std::string, ExecFlagEnum >::iterator	begin ()
	Provide iterator and find access to the underlying map data. More...
std::map< std::string, ExecFlagEnum >::const_iterator	begin () const
std::map< std::string, ExecFlagEnum >::iterator	end ()
std::map< std::string, ExecFlagEnum >::const_iterator	end () const
std::map< std::string, ExecFlagEnum >::iterator	find (const std::string &name)
const std::map< std::string, ExecFlagEnum >::const_iterator	find (const std::string &name) const

Protected Attributes
std::map< std::string, ExecFlagEnum >	_map
	Data storage. More...

Detailed Description

A helper warehouse class for storing the "execute_on" settings for the various output types.

In order to allow for new output types to be defined and to minimize the number of member variables the "execute_on" parameter for each of the output types (e.g., execute_postprocessors_on) are stored in a map.

This allows for iterative access to these parameters, which makes creating generic code (e.g., AdvancedOutput::shouldOutput) possible. However, ExecFlagEnum has a private constructor, so calling operator[] on the map is a compile time error.

To get around this and to provide a more robust storage structure, one that will error if the wrong output name is given, this warehouse was created. For the purposes of the AdvancedOutput object this warehouse functions exactly like a std::map, but provides an operator[] that works with ExecFlagEnum and errors if called on an invalid key.

See also

OutputMapWrapper OutputDataWarehouse

Definition at line 127 of file AdvancedOutputUtils.h.

Constructor & Destructor Documentation

OutputOnWarehouse()

OutputOnWarehouse::OutputOnWarehouse	(	const ExecFlagEnum &	execute_on,
		const InputParameters &	parameters
	)

Constructor.

Parameters

execute_on	The general "execute_on" settings for the object.
parameters	The parameters object holding data for the class to use.

Definition at line 25 of file AdvancedOutputUtils.C.

  : OutputMapWrapper<ExecFlagEnum>()
{
  // Initialize each of the 'execute_on' settings for the various types of outputs
  if (parameters.have_parameter<ExecFlagEnum>("execute_nodal_on"))
    _map.insert(std::make_pair("nodal", execute_on));

  if (parameters.have_parameter<ExecFlagEnum>("execute_elemental_on"))
    _map.insert(std::make_pair("elemental", execute_on));

  if (parameters.have_parameter<ExecFlagEnum>("execute_scalars_on"))
    _map.insert(std::make_pair("scalars", execute_on));

  if (parameters.have_parameter<ExecFlagEnum>("execute_postprocessors_on"))
    _map.insert(std::make_pair("postprocessors", execute_on));

  if (parameters.have_parameter<ExecFlagEnum>("execute_vector_postprocessors_on"))
    _map.insert(std::make_pair("vector_postprocessors", execute_on));

  if (parameters.have_parameter<ExecFlagEnum>("execute_reporters_on"))
    _map.insert(std::make_pair("reporters", execute_on));

  if (parameters.have_parameter<ExecFlagEnum>("execute_input_on"))
    _map.insert(std::make_pair("input", MooseUtils::getDefaultExecFlagEnum()));

  if (parameters.have_parameter<ExecFlagEnum>("execute_system_information_on"))
  {
    ExecFlagEnum flags = MooseUtils::getDefaultExecFlagEnum();
    flags = EXEC_INITIAL;
    _map.insert(std::make_pair("system_information", flags));
  }
}

Member Function Documentation

begin() [1/2]

std::map<std::string, ExecFlagEnum >::iterator OutputMapWrapper< ExecFlagEnum >::begin ( )

inlineinherited

Provide iterator and find access to the underlying map data.

Definition at line 84 of file AdvancedOutputUtils.h.

{ return _map.begin(); }

begin() [2/2]

std::map<std::string, ExecFlagEnum >::const_iterator OutputMapWrapper< ExecFlagEnum >::begin ( ) const

inlineinherited

Definition at line 90 of file AdvancedOutputUtils.h.

{ return _map.begin(); }

contains()

bool OutputMapWrapper< ExecFlagEnum >::contains ( const std::string &  name ) const

inlineinherited

A method for testing of a key exists.

Definition at line 101 of file AdvancedOutputUtils.h.

{ return find(name) != end(); }

end() [1/2]

std::map<std::string, ExecFlagEnum >::iterator OutputMapWrapper< ExecFlagEnum >::end ( )

inlineinherited

Definition at line 85 of file AdvancedOutputUtils.h.

{ return _map.end(); }

end() [2/2]

std::map<std::string, ExecFlagEnum >::const_iterator OutputMapWrapper< ExecFlagEnum >::end ( ) const

inlineinherited

Definition at line 91 of file AdvancedOutputUtils.h.

{ return _map.end(); }

find() [1/2]

std::map<std::string, ExecFlagEnum >::iterator OutputMapWrapper< ExecFlagEnum >::find ( const std::string &  name )

inlineinherited

Definition at line 86 of file AdvancedOutputUtils.h.

  {
    return _map.find(name);
  }

find() [2/2]

const std::map<std::string, ExecFlagEnum >::const_iterator OutputMapWrapper< ExecFlagEnum >::find ( const std::string &  name ) const

inlineinherited

Definition at line 92 of file AdvancedOutputUtils.h.

  {
    return _map.find(name);
  }

operator[]()

ExecFlagEnum & OutputMapWrapper< ExecFlagEnum >::operator[] ( const std::string &  name )

inlineinherited

A map accessor that errors if the key is not found.

Definition at line 71 of file AdvancedOutputUtils.h.

  {
    // Locate the map entry, error if it is not found
    typename std::map<std::string, T>::iterator iter = _map.find(name);
    if (iter == _map.end())
      mooseError("Unknown map key ", name);
    return iter->second;
  }

Member Data Documentation

_map

std::map<std::string, ExecFlagEnum > OutputMapWrapper< ExecFlagEnum >::_map

protectedinherited

Data storage.

Definition at line 105 of file AdvancedOutputUtils.h.

Referenced by OutputOnWarehouse().

---

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

• include/outputs/AdvancedOutputUtils.h
• src/outputs/AdvancedOutputUtils.C