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