www.mooseframework.org
CumulativeValuePostprocessor.C
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 
16 
17 template <>
20 {
22  params.addRequiredParam<PostprocessorName>("postprocessor", "The name of the postprocessor");
23  return params;
24 }
25 
27  : GeneralPostprocessor(parameters),
28  _sum(0.0),
29  _sum_old(getPostprocessorValueOldByName(name())),
30  _pps_value(getPostprocessorValue("postprocessor"))
31 {
32 }
33 
34 void
36 {
37 }
38 
39 void
41 {
43 }
44 
45 Real
47 {
48  return _sum;
49 }
CumulativeValuePostprocessor(const InputParameters &parameters)
virtual void execute() override
Execute method.
Real _sum
cumulative sum of the post-processor value
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
virtual Real getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
const PostprocessorValue & _pps_value
current post-processor value to be added to the cumulative sum
const PostprocessorValue & _sum_old
cumulative sum of the post-processor value from the old time step */
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
InputParameters validParams< CumulativeValuePostprocessor >()