https://mooseframework.inl.gov
Loading...
Searching...
No Matches
PorousFlowPlotQuantity.C
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
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
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
32void
36
37void
41
Real PostprocessorValue
registerMooseObject("PorousFlowApp", PorousFlowPlotQuantity)
static InputParameters validParams()
void addRequiredParam(const std::string &name, const std::string &doc_string)
void addClassDescription(const std::string &doc_string)
Extracts the value from PorousFlowSumQuantity userobject.
virtual PostprocessorValue getValue() const override
Returns the value of the PorousFlowSumQuantity.
const PorousFlowSumQuantity & _total_mass
The PorousFlowSumQuantity userobject.
virtual void execute() override
virtual void initialize() override
PorousFlowPlotQuantity(const InputParameters &parameters)
static InputParameters validParams()
Sums into _total This is used, for instance, to record the total mass flowing into a borehole.
virtual Real getValue() const
Returns _total.