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 () |
static std::string | deduceFunctorName (const std::string &name, const InputParameters ¶ms) |
Helper to look up a functor name through the input parameter keys. More... | |
Protected Member Functions | |
VectorPostprocessorValue & | declareVector (const std::string &vector_name) |
Register a new vector to fill up. More... | |
std::string | deduceFunctorName (const std::string &name) const |
Small helper to look up a functor name through the input parameter keys. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name) |
Retrieves a functor from the subproblem. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name, THREAD_ID tid) |
Retrieves a functor from the subproblem. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name, SubProblem &subproblem) |
Retrieves a functor from the passed-in subproblem. More... | |
template<typename T > | |
const Moose::Functor< T > & | getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid) |
Retrieves a functor from the passed-in subproblem. More... | |
bool | isFunctor (const std::string &name) const |
Checks the subproblem for the given functor. More... | |
bool | isFunctor (const std::string &name, const SubProblem &subproblem) const |
Checks the passed-in subproblem for the given functor. More... | |
Moose::ElemArg | makeElemArg (const Elem *elem, bool correct_skewnewss=false) const |
Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections. More... | |
template<typename T > | |
void | checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration) |
Throws error if the functor does not support the requested side integration. 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 34 of file VectorPostprocessor.h.
VectorPostprocessor::VectorPostprocessor | ( | const MooseObject * | moose_object | ) |
Definition at line 52 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().
|
protectedinherited |
Throws error if the functor does not support the requested side integration.
[in] | name | Name of functor or functor parameter |
[in] | qp_integration | True if performing qp integration, false if face info |
Definition at line 236 of file FunctorInterface.h.
|
inline |
Return whether or not this VectorPostprocessor contains complete history.
Definition at line 51 of file VectorPostprocessor.h.
Referenced by SamplerBase::finalize(), ElementMaterialSampler::initialize(), SamplerBase::initialize(), and CSV::output().
|
protected |
Register a new vector to fill up.
Definition at line 70 of file VectorPostprocessor.C.
Referenced by ConstantVectorPostprocessor::ConstantVectorPostprocessor(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), ElementMaterialSampler::ElementMaterialSampler(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), HistogramVectorPostprocessor::initialSetup(), LeastSquaresFit::LeastSquaresFit(), LeastSquaresFitHistory::LeastSquaresFitHistory(), MeshDivisionFunctorReductionVectorPostprocessor::MeshDivisionFunctorReductionVectorPostprocessor(), SamplerBase::setupVariables(), SidesetInfoVectorPostprocessor::SidesetInfoVectorPostprocessor(), SpatialAverageBase::SpatialAverageBase(), and WorkBalance::WorkBalance().
|
staticinherited |
Helper to look up a functor name through the input parameter keys.
name | The input parameter name that we are trying to deduce the functor name for |
params | The input parameters object that we will be checking for parameters named name |
Definition at line 28 of file FunctorInterface.C.
Referenced by FunctorInterface::checkFunctorSupportsSideIntegration(), FunctorInterface::deduceFunctorName(), FunctorInterface::getFunctor(), and FunctorInterface::isFunctor().
|
protectedinherited |
Small helper to look up a functor name through the input parameter keys.
Definition at line 60 of file FunctorInterface.C.
|
protectedinherited |
Retrieves a functor from the subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
Definition at line 200 of file FunctorInterface.h.
Referenced by MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl().
|
protectedinherited |
Retrieves a functor from the subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
tid | The thread ID used to retrieve the functor from this interface's subproblem |
Definition at line 192 of file FunctorInterface.h.
|
protectedinherited |
Retrieves a functor from the passed-in subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
subproblem | The subproblem to query for the functor |
Definition at line 185 of file FunctorInterface.h.
|
protectedinherited |
Retrieves a functor from the passed-in subproblem.
This method also leverages the ability to create default functors if the user passed an integer or real in the input file
name | The name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file |
subproblem | The subproblem to query for the functor |
tid | The thread ID used to retrieve the functor from the subproblem |
Definition at line 176 of file FunctorInterface.h.
|
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 91 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 56 of file VectorPostprocessor.h.
Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributedByName(), and XMLOutput::outputVectorPostprocessors().
|
protectedinherited |
Checks the subproblem for the given functor.
This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file
name | The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file |
Definition at line 113 of file FunctorInterface.C.
|
protectedinherited |
Checks the passed-in subproblem for the given functor.
This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file
name | The name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file |
subproblem | The subproblem to query for the functor |
Definition at line 104 of file FunctorInterface.C.
|
protectedinherited |
Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.
Definition at line 120 of file FunctorInterface.C.
Referenced by LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVAdvectionDiffusionFunctorNeumannBC::computeBoundaryValue(), LinearFVReaction::computeMatrixContribution(), LinearFVTimeDerivative::computeMatrixContribution(), FVFunctorTimeKernel::computeQpResidual(), FVCoupledForce::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), LinearFVSource::computeRightHandSideContribution(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), FunctorAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), FunctorTimes::initialize(), and LinearFVTimeDerivative::setCurrentElemInfo().
|
inline |
Returns the name of the VectorPostprocessor.
Definition at line 46 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 78 of file VectorPostprocessor.h.
|
private |
Definition at line 85 of file VectorPostprocessor.h.
Referenced by containsCompleteHistory().
|
private |
Definition at line 89 of file VectorPostprocessor.h.
Referenced by declareVector().
|
private |
Definition at line 87 of file VectorPostprocessor.h.
Referenced by declareVector(), and isDistributed().
|
protected |
DISTRIBUTED or REPLICATED.
Definition at line 76 of file VectorPostprocessor.h.
|
private |
Definition at line 91 of file VectorPostprocessor.h.
Referenced by declareVector().
|
private |
Definition at line 93 of file VectorPostprocessor.h.
Referenced by declareVector(), and getVectorNames().
|
protected |
The FEProblemBase.
Definition at line 73 of file VectorPostprocessor.h.
Referenced by declareVector().
|
private |
Definition at line 81 of file VectorPostprocessor.h.
Referenced by declareVector().
|
protected |
The name of the VectorPostprocessor.
Definition at line 70 of file VectorPostprocessor.h.
Referenced by declareVector(), and PPName().
|
private |
Definition at line 83 of file VectorPostprocessor.h.
Referenced by declareVector().