VectorPostprocessorInterface

The VectorPostprocessorInterface defines the methods used for retrieving references to VectorPostprocessor values. Many objects in MOOSE support the retrieval of these references for use in calculations.

/**
 * Retrieve the value of a VectorPostprocessor
 * @param param_name The name of the VectorPostprocessor parameter (see below)
 * @param vector_name The name of the particular vector you want.
 * @param need_broadcast Whether or not this object requires the vector to
 * be replicated in parallel
 * @return A reference to the desired value
 *
 * The name required by this method is the name that is hard-coded into
 * your source code. For example, if you have a Kernel that requires
 * a VectorPostprocessor you may have an input file with "pp = my_pp", this function
 * requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)
 *
 * see getVectorPostprocessorValueOld getVectorPostprocessorValueByName
 * getVectorPostprocessorValueOldByName
 */
const VectorPostprocessorValue & getVectorPostprocessorValue(const std::string & param_name,
                                                             const std::string & vector_name,
                                                             bool needs_broadcast) const;
(contrib/moose/framework/include/vectorpostprocessors/VectorPostprocessorInterface.h)