https://mooseframework.inl.gov
Loading...
Searching...
No Matches
PorousFlowSumQuantity.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
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
22{
23public:
25
27 virtual ~PorousFlowSumQuantity();
28
30 void zero();
31
36 void add(Real contrib);
37
39 virtual void initialize() override;
40
42 virtual void execute() override;
43
45 virtual void finalize() override;
46
48 virtual Real getValue() const;
49
50protected:
52 Real _total;
53};
const InputParameters & parameters() const
Sums into _total This is used, for instance, to record the total mass flowing into a borehole.
void add(Real contrib)
Adds contrib to _total.
Real _total
This holds the sum.
virtual void execute() override
Does nothing.
virtual void finalize() override
Does MPI gather on _total.
virtual Real getValue() const
Returns _total.
void zero()
Sets _total = 0.
virtual void initialize() override
Does nothing.
static InputParameters validParams()