VectorPostprocessor Class Reference

Base class for Postprocessors that produce a vector of values. More...

#include <VectorPostprocessor.h>

Inheritance diagram for VectorPostprocessor:

Public Member Functions
	VectorPostprocessor (const InputParameters &parameters)
virtual	~VectorPostprocessor ()=default
virtual VectorPostprocessorValue &	getVector (const std::string &vector_name)
	This will get called to actually grab the final value the VectorPostprocessor has calculated. More...
std::string	PPName ()
	Returns the name of the VectorPostprocessor. More...
bool	containsCompleteHistory () const
	Return whether or not this VectorPostprocessor contains complete history. 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...

Protected Member Functions
VectorPostprocessorValue &	declareVector (const std::string &vector_name)
	Register a new vector to fill up. More...

Protected Attributes
std::string	_vpp_name
	The name of the VectorPostprocessor. More...
FEProblemBase *	_vpp_fe_problem
	Pointer to FEProblemBase. More...

Private Attributes
THREAD_ID	_vpp_tid
const bool	_contains_complete_history
const bool	_is_broadcast
std::map< std::string, VectorPostprocessorValue >	_thread_local_vectors

Friends
class	SamplerBase

Detailed Description

Base class for Postprocessors that produce a vector of values.

Definition at line 36 of file VectorPostprocessor.h.

Constructor & Destructor Documentation

VectorPostprocessor()

VectorPostprocessor::VectorPostprocessor

(

const InputParameters &

parameters

)

Definition at line 40 of file VectorPostprocessor.C.

  : OutputInterface(parameters),
    _vpp_name(MooseUtils::shortName(parameters.get<std::string>("_object_name"))),
    _vpp_fe_problem(parameters.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
    _vpp_tid(parameters.isParamValid("_tid") ? parameters.get<THREAD_ID>("_tid") : 0),
    _contains_complete_history(parameters.get<bool>("contains_complete_history")),
    _is_broadcast(parameters.get<bool>("_is_broadcast"))
{
}

~VectorPostprocessor()

virtual VectorPostprocessor::~VectorPostprocessor ( )

virtualdefault

Member Function Documentation

buildOutputHideVariableList()

void OutputInterface::buildOutputHideVariableList ( std::set< std::string >  variable_names )

inherited

Builds hide lists for output objects NOT listed in the 'outputs' parameter.

Parameters

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 62 of file OutputInterface.C.

Referenced by CheckOutputAction::checkVariableOutput(), and OutputInterface::OutputInterface().

{
  // Set of available names
  const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();

  // Check for 'none'; hide variables on all outputs
  if (_oi_outputs.find("none") != _oi_outputs.end())
    for (const auto & name : avail)
      _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);

  // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
  // these cases
  else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
    return;

  // Limit the variable output to Output objects listed
  else
  {
    // Create a list of outputs where the variable should be hidden
    std::set<OutputName> hide;
    std::set_difference(avail.begin(),
                        avail.end(),
                        _oi_outputs.begin(),
                        _oi_outputs.end(),
                        std::inserter(hide, hide.begin()));

    // If 'outputs' is specified add the object name to the list of items to hide
    for (const auto & name : hide)
      _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
  }
}

containsCompleteHistory()

bool VectorPostprocessor::containsCompleteHistory ( ) const

inline

Return whether or not this VectorPostprocessor contains complete history.

Definition at line 56 of file VectorPostprocessor.h.

Referenced by SamplerBase::initialize().

{ return _contains_complete_history; }

declareVector()

VectorPostprocessorValue & VectorPostprocessor::declareVector ( const std::string &  vector_name )

protected

Register a new vector to fill up.

Definition at line 57 of file VectorPostprocessor.C.

Referenced by CSVReader::initialize(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), LeastSquaresFit::LeastSquaresFit(), LeastSquaresFitHistory::LeastSquaresFitHistory(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), SamplerBase::setupVariables(), and SpatialAverageBase::SpatialAverageBase().

{
  if (_vpp_tid)
    return _thread_local_vectors.emplace(vector_name, VectorPostprocessorValue()).first->second;
  else
    return _vpp_fe_problem->declareVectorPostprocessorVector(
        _vpp_name, vector_name, _contains_complete_history, _is_broadcast);
}

getOutputs()

const std::set< OutputName > & OutputInterface::getOutputs ( )

inherited

Get the list of output objects that this class is restricted.

Returns

A set of OutputNames

Definition at line 95 of file OutputInterface.C.

{
  return _oi_outputs;
}

getVector()

VectorPostprocessorValue & VectorPostprocessor::getVector ( const std::string &  vector_name )

virtual

This will get called to actually grab the final value the VectorPostprocessor has calculated.

Definition at line 51 of file VectorPostprocessor.C.

{
  return _vpp_fe_problem->getVectorPostprocessorValue(_vpp_name, vector_name);
}

PPName()

std::string VectorPostprocessor::PPName ( )

inline

Returns the name of the VectorPostprocessor.

Definition at line 51 of file VectorPostprocessor.h.

{ return _vpp_name; }

Friends And Related Function Documentation

SamplerBase

friend class SamplerBase

friend

Definition at line 70 of file VectorPostprocessor.h.

Member Data Documentation

_contains_complete_history

const bool VectorPostprocessor::_contains_complete_history

private

Definition at line 75 of file VectorPostprocessor.h.

Referenced by containsCompleteHistory(), and declareVector().

_is_broadcast

const bool VectorPostprocessor::_is_broadcast

private

Definition at line 77 of file VectorPostprocessor.h.

Referenced by declareVector().

_thread_local_vectors

std::map<std::string, VectorPostprocessorValue> VectorPostprocessor::_thread_local_vectors

private

Definition at line 79 of file VectorPostprocessor.h.

Referenced by declareVector().

_vpp_fe_problem

FEProblemBase* VectorPostprocessor::_vpp_fe_problem

protected

Pointer to FEProblemBase.

Definition at line 68 of file VectorPostprocessor.h.

Referenced by declareVector(), LineValueSampler::getValue(), and getVector().

_vpp_name

std::string VectorPostprocessor::_vpp_name

protected

The name of the VectorPostprocessor.

Definition at line 65 of file VectorPostprocessor.h.

Referenced by declareVector(), LineValueSampler::getValue(), getVector(), and PPName().

_vpp_tid

THREAD_ID VectorPostprocessor::_vpp_tid

private

Definition at line 73 of file VectorPostprocessor.h.

Referenced by declareVector().

---

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

• include/vectorpostprocessors/VectorPostprocessor.h
• src/vectorpostprocessors/VectorPostprocessor.C