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 
17 {
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 
26  : GeneralPostprocessor(parameters), _total_mass(getUserObject<PorousFlowSumQuantity>("uo"))
27 {
28 }
29 
31 
32 void
34 {
35 }
36 
37 void
39 {
40 }
41 
44 {
45  return _total_mass.getValue();
46 }
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
static InputParameters validParams()
PorousFlowPlotQuantity(const InputParameters &parameters)
virtual void initialize() override
Real PostprocessorValue
Sums into _total This is used, for instance, to record the total mass flowing into a borehole...
virtual PostprocessorValue getValue() const override
Returns the value of the PorousFlowSumQuantity.
virtual Real getValue() const
Returns _total.
registerMooseObject("PorousFlowApp", PorousFlowPlotQuantity)
void addClassDescription(const std::string &doc_string)
const PorousFlowSumQuantity & _total_mass
The PorousFlowSumQuantity userobject.
Extracts the value from PorousFlowSumQuantity userobject.
virtual void execute() override