www.mooseframework.org
porous_flow
src
userobjects
PorousFlowSumQuantity.C
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
#include "
PorousFlowSumQuantity.h
"
11
12
registerMooseObject
(
"PorousFlowApp"
,
PorousFlowSumQuantity
);
13
14
template
<>
15
InputParameters
16
validParams<PorousFlowSumQuantity>
()
17
{
18
InputParameters params = validParams<GeneralUserObject>();
19
params.addClassDescription(
"Records total mass flowing into a borehole"
);
20
return
params;
21
}
22
23
PorousFlowSumQuantity::PorousFlowSumQuantity
(
const
InputParameters & parameters)
24
: GeneralUserObject(parameters), _total(0.0)
25
{
26
}
27
28
PorousFlowSumQuantity::~PorousFlowSumQuantity
() {}
29
30
void
31
PorousFlowSumQuantity::zero
()
32
{
33
_total
= 0.0;
34
}
35
36
void
37
PorousFlowSumQuantity::add
(Real contrib)
38
{
39
_total
+= contrib;
40
}
41
42
void
43
PorousFlowSumQuantity::initialize
()
44
{
45
}
46
47
void
48
PorousFlowSumQuantity::execute
()
49
{
50
}
51
52
void
53
PorousFlowSumQuantity::finalize
()
54
{
55
gatherSum(
_total
);
56
}
57
58
Real
59
PorousFlowSumQuantity::getValue
()
const
60
{
61
return
_total
;
62
}
PorousFlowSumQuantity::_total
Real _total
This holds the sum.
Definition:
PorousFlowSumQuantity.h:55
PorousFlowSumQuantity::~PorousFlowSumQuantity
virtual ~PorousFlowSumQuantity()
Definition:
PorousFlowSumQuantity.C:28
PorousFlowSumQuantity::execute
virtual void execute() override
Does nothing.
Definition:
PorousFlowSumQuantity.C:48
PorousFlowSumQuantity.h
validParams< PorousFlowSumQuantity >
InputParameters validParams< PorousFlowSumQuantity >()
Definition:
PorousFlowSumQuantity.C:16
PorousFlowSumQuantity::zero
void zero()
Sets _total = 0.
Definition:
PorousFlowSumQuantity.C:31
PorousFlowSumQuantity::getValue
virtual Real getValue() const
Returns _total.
Definition:
PorousFlowSumQuantity.C:59
PorousFlowSumQuantity::finalize
virtual void finalize() override
Does MPI gather on _total.
Definition:
PorousFlowSumQuantity.C:53
PorousFlowSumQuantity::initialize
virtual void initialize() override
Does nothing.
Definition:
PorousFlowSumQuantity.C:43
registerMooseObject
registerMooseObject("PorousFlowApp", PorousFlowSumQuantity)
PorousFlowSumQuantity::add
void add(Real contrib)
Adds contrib to _total.
Definition:
PorousFlowSumQuantity.C:37
PorousFlowSumQuantity
Sums into _total This is used, for instance, to record the total mass flowing into a borehole.
Definition:
PorousFlowSumQuantity.h:26
PorousFlowSumQuantity::PorousFlowSumQuantity
PorousFlowSumQuantity(const InputParameters ¶meters)
Definition:
PorousFlowSumQuantity.C:23
Generated on Sat Jan 25 2020 12:04:42 for www.mooseframework.org by
1.8.16