www.mooseframework.org
richards
src
userobjects
RichardsSumQuantity.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 "
RichardsSumQuantity.h
"
11
12
registerMooseObject
(
"RichardsApp"
,
RichardsSumQuantity
);
13
14
template
<>
15
InputParameters
16
validParams<RichardsSumQuantity>
()
17
{
18
InputParameters params = validParams<GeneralUserObject>();
19
20
return
params;
21
}
22
23
RichardsSumQuantity::RichardsSumQuantity
(
const
InputParameters & parameters)
24
: GeneralUserObject(parameters), _total(0)
25
{
26
}
27
28
RichardsSumQuantity::~RichardsSumQuantity
() {}
29
30
void
31
RichardsSumQuantity::zero
()
32
{
33
_total
= 0;
34
}
35
36
void
37
RichardsSumQuantity::add
(Real contrib)
38
{
39
_total
+= contrib;
40
}
41
42
void
43
RichardsSumQuantity::initialize
()
44
{
45
}
46
47
void
48
RichardsSumQuantity::execute
()
49
{
50
}
51
52
void
53
RichardsSumQuantity::finalize
()
54
{
55
gatherSum(
_total
);
56
}
57
58
Real
59
RichardsSumQuantity::getValue
()
const
60
{
61
return
_total
;
62
}
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
registerMooseObject
registerMooseObject("RichardsApp", RichardsSumQuantity)
RichardsSumQuantity.h
RichardsSumQuantity::_total
Real _total
this holds the sum
Definition:
RichardsSumQuantity.h:55
RichardsSumQuantity::RichardsSumQuantity
RichardsSumQuantity(const InputParameters ¶meters)
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
validParams< RichardsSumQuantity >
InputParameters validParams< RichardsSumQuantity >()
Definition:
RichardsSumQuantity.C:16
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
Generated on Sat Jan 25 2020 12:04:43 for www.mooseframework.org by
1.8.16