Base class for Postprocessors that produce a vector of values. More...
#include <VectorPostprocessor.h>
Public Member Functions | |
VectorPostprocessor (const MooseObject *moose_object) | |
virtual | ~VectorPostprocessor ()=default |
std::string | PPName () const |
Returns the name of the VectorPostprocessor. More... | |
bool | containsCompleteHistory () const |
Return whether or not this VectorPostprocessor contains complete history. More... | |
bool | isDistributed () const |
Return true if the VPP is operating in distributed mode. More... | |
const std::set< std::string > & | getVectorNames () const |
Return the names of the vectors associated with this object. 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 () |
Protected Member Functions | |
VectorPostprocessorValue & | declareVector (const std::string &vector_name) |
Register a new vector to fill up. More... | |
Protected Attributes | |
const std::string | _vpp_name |
The name of the VectorPostprocessor. More... | |
FEProblemBase & | _vpp_fe_problem |
The FEProblemBase. More... | |
const MooseEnum & | _parallel_type |
DISTRIBUTED or REPLICATED. More... | |
Private Attributes | |
const MooseObject & | _vpp_moose_object |
const THREAD_ID | _vpp_tid |
const bool | _contains_complete_history |
const bool | _is_distributed |
const bool | _is_broadcast |
std::map< std::string, VectorPostprocessorValue > | _thread_local_vectors |
std::set< std::string > | _vector_names |
Friends | |
class | SamplerBase |
Base class for Postprocessors that produce a vector of values.
Definition at line 33 of file VectorPostprocessor.h.
VectorPostprocessor::VectorPostprocessor | ( | const MooseObject * | moose_object | ) |
Definition at line 51 of file VectorPostprocessor.C.
|
virtualdefault |
|
inherited |
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::OutputInterface().
|
inline |
Return whether or not this VectorPostprocessor contains complete history.
Definition at line 50 of file VectorPostprocessor.h.
Referenced by MaterialVectorPostprocessor::initialize(), SamplerBase::initialize(), and CSV::output().
|
protected |
Register a new vector to fill up.
Definition at line 68 of file VectorPostprocessor.C.
Referenced by ConstantVectorPostprocessor::ConstantVectorPostprocessor(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), HistogramVectorPostprocessor::initialSetup(), LeastSquaresFit::LeastSquaresFit(), LeastSquaresFitHistory::LeastSquaresFitHistory(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), MeshDivisionFunctorReductionVectorPostprocessor::MeshDivisionFunctorReductionVectorPostprocessor(), SamplerBase::setupVariables(), SidesetInfoVectorPostprocessor::SidesetInfoVectorPostprocessor(), SpatialAverageBase::SpatialAverageBase(), and WorkBalance::WorkBalance().
|
inherited |
Get the list of output objects that this class is restricted.
Definition at line 94 of file OutputInterface.C.
const std::set< std::string > & VectorPostprocessor::getVectorNames | ( | ) | const |
Return the names of the vectors associated with this object.
Definition at line 89 of file VectorPostprocessor.C.
Referenced by HistogramVectorPostprocessor::execute(), and HistogramVectorPostprocessor::initialSetup().
|
inline |
Return true if the VPP is operating in distributed mode.
Definition at line 55 of file VectorPostprocessor.h.
Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributedByName(), and XMLOutput::outputVectorPostprocessors().
|
inline |
Returns the name of the VectorPostprocessor.
Definition at line 45 of file VectorPostprocessor.h.
|
static |
Definition at line 18 of file VectorPostprocessor.C.
Referenced by ElementVectorPostprocessor::validParams(), SideVectorPostprocessor::validParams(), InternalSideVectorPostprocessor::validParams(), InterfaceVectorPostprocessor::validParams(), NodalVectorPostprocessor::validParams(), and GeneralVectorPostprocessor::validParams().
|
friend |
Definition at line 77 of file VectorPostprocessor.h.
|
private |
Definition at line 84 of file VectorPostprocessor.h.
Referenced by containsCompleteHistory().
|
private |
Definition at line 88 of file VectorPostprocessor.h.
Referenced by declareVector().
|
private |
Definition at line 86 of file VectorPostprocessor.h.
Referenced by declareVector(), and isDistributed().
|
protected |
DISTRIBUTED or REPLICATED.
Definition at line 75 of file VectorPostprocessor.h.
|
private |
Definition at line 90 of file VectorPostprocessor.h.
Referenced by declareVector().
|
private |
Definition at line 92 of file VectorPostprocessor.h.
Referenced by declareVector(), and getVectorNames().
|
protected |
The FEProblemBase.
Definition at line 72 of file VectorPostprocessor.h.
Referenced by declareVector().
|
private |
Definition at line 80 of file VectorPostprocessor.h.
Referenced by declareVector().
|
protected |
The name of the VectorPostprocessor.
Definition at line 69 of file VectorPostprocessor.h.
Referenced by declareVector(), and PPName().
|
private |
Definition at line 82 of file VectorPostprocessor.h.
Referenced by declareVector().