www.mooseframework.org
richards
src
postprocessors
RichardsPlotQuantity.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 "
RichardsPlotQuantity.h
"
11
#include "
RichardsSumQuantity.h
"
12
13
registerMooseObject
(
"RichardsApp"
,
RichardsPlotQuantity
);
14
15
InputParameters
16
RichardsPlotQuantity::validParams
()
17
{
18
InputParameters
params =
GeneralPostprocessor::validParams
();
19
params.
addRequiredParam
<UserObjectName>(
"uo"
,
"user object name that has the total mass value"
);
20
21
return
params;
22
}
23
24
RichardsPlotQuantity::RichardsPlotQuantity
(
const
InputParameters
& parameters)
25
:
GeneralPostprocessor
(parameters), _total_mass(getUserObject<
RichardsSumQuantity
>(
"uo"
))
26
{
27
}
28
29
RichardsPlotQuantity::~RichardsPlotQuantity
() {}
30
31
void
32
RichardsPlotQuantity::initialize
()
33
{
34
}
35
36
void
37
RichardsPlotQuantity::execute
()
38
{
39
}
40
41
PostprocessorValue
42
RichardsPlotQuantity::getValue
()
const
43
{
44
return
_total_mass
.
getValue
();
45
}
RichardsSumQuantity
Sums into _total This is used, for instance, to record the total mass flowing into a borehole...
Definition:
RichardsSumQuantity.h:21
RichardsSumQuantity.h
RichardsPlotQuantity::getValue
virtual PostprocessorValue getValue() const override
returns the value of the RichardsSumQuantity
Definition:
RichardsPlotQuantity.C:42
RichardsPlotQuantity.h
GeneralPostprocessor
RichardsPlotQuantity::RichardsPlotQuantity
RichardsPlotQuantity(const InputParameters ¶meters)
Definition:
RichardsPlotQuantity.C:24
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
GeneralPostprocessor::validParams
static InputParameters validParams()
InputParameters
RichardsPlotQuantity::validParams
static InputParameters validParams()
Definition:
RichardsPlotQuantity.C:16
PostprocessorValue
Real PostprocessorValue
RichardsSumQuantity::getValue
virtual Real getValue() const
returns _total
Definition:
RichardsSumQuantity.C:58
RichardsPlotQuantity::initialize
virtual void initialize() override
Definition:
RichardsPlotQuantity.C:32
RichardsPlotQuantity::_total_mass
const RichardsSumQuantity & _total_mass
the RichardsSumQuantity userobject
Definition:
RichardsPlotQuantity.h:35
registerMooseObject
registerMooseObject("RichardsApp", RichardsPlotQuantity)
RichardsPlotQuantity::execute
virtual void execute() override
Definition:
RichardsPlotQuantity.C:37
RichardsPlotQuantity::~RichardsPlotQuantity
virtual ~RichardsPlotQuantity()
Definition:
RichardsPlotQuantity.C:29
RichardsPlotQuantity
Extracts the value from RichardsSumQuantity userobject.
Definition:
RichardsPlotQuantity.h:19
Generated on Thu Apr 18 2024 15:39:22 for www.mooseframework.org by
1.8.14