www.mooseframework.org
LinearCombinationPostprocessor.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 #ifndef LINEARCOMBINATIONPOSTPROCESSOR_H
15 #define LINEARCOMBINATIONPOSTPROCESSOR_H
16 
17 #include "GeneralPostprocessor.h"
18 
20 
21 template <>
23 
35 {
36 public:
38 
39  virtual void initialize() override;
40  virtual void execute() override;
41  virtual PostprocessorValue getValue() override;
42 
43 protected:
45  const std::vector<PostprocessorName> & _pp_names;
47  const unsigned int _n_pp;
49  const std::vector<Real> & _pp_coefs;
51  const Real _b_value;
52 
54  std::vector<const PostprocessorValue *> _pp_values;
55 };
56 
57 #endif /* LINEARCOMBINATIONPOSTPROCESSOR_H */
std::vector< const PostprocessorValue * > _pp_values
List of post-processor values.
Computes a linear combination between an arbitrary number of post-processors.
const unsigned int _n_pp
Number of post-processors in linear combination.
const Real _b_value
Additional value to add to sum.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const std::vector< PostprocessorName > & _pp_names
List of names of post-processors to include in linear combination.
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
InputParameters validParams< LinearCombinationPostprocessor >()
virtual void execute() override
Execute method.
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:73
const std::vector< Real > & _pp_coefs
List of linear combination coefficients for each post-processor value.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
virtual PostprocessorValue getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
LinearCombinationPostprocessor(const InputParameters &parameters)