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