www.mooseframework.org
RichardsSumQuantity.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "GeneralUserObject.h"
13 
15 
16 template <>
17 InputParameters validParams<RichardsSumQuantity>();
18 
26 class RichardsSumQuantity : public GeneralUserObject
27 {
28 public:
29  RichardsSumQuantity(const InputParameters & parameters);
30  virtual ~RichardsSumQuantity();
31 
33  void zero();
34 
39  void add(Real contrib);
40 
42  virtual void initialize();
43 
45  virtual void execute();
46 
48  virtual void finalize();
49 
51  virtual Real getValue() const;
52 
53 protected:
55  Real _total;
56 };
57 
RichardsSumQuantity::zero
void zero()
sets _total = 0
Definition: RichardsSumQuantity.C:31
RichardsSumQuantity::initialize
virtual void initialize()
does nothing
Definition: RichardsSumQuantity.C:43
RichardsSumQuantity::execute
virtual void execute()
does nothing
Definition: RichardsSumQuantity.C:48
RichardsSumQuantity::_total
Real _total
this holds the sum
Definition: RichardsSumQuantity.h:55
RichardsSumQuantity::RichardsSumQuantity
RichardsSumQuantity(const InputParameters &parameters)
Definition: RichardsSumQuantity.C:23
RichardsSumQuantity::~RichardsSumQuantity
virtual ~RichardsSumQuantity()
Definition: RichardsSumQuantity.C:28
RichardsSumQuantity::getValue
virtual Real getValue() const
returns _total
Definition: RichardsSumQuantity.C:59
RichardsSumQuantity::add
void add(Real contrib)
adds contrib to _total
Definition: RichardsSumQuantity.C:37
RichardsSumQuantity::finalize
virtual void finalize()
does MPI gather on _total
Definition: RichardsSumQuantity.C:53
RichardsSumQuantity
Sums into _total This is used, for instance, to record the total mass flowing into a borehole.
Definition: RichardsSumQuantity.h:26
validParams< RichardsSumQuantity >
InputParameters validParams< RichardsSumQuantity >()
Definition: RichardsSumQuantity.C:16