www.mooseframework.org
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 
14 
17 {
19  params.addRequiredParam<UserObjectName>("uo", "user object name that has the total mass value");
20 
21  return params;
22 }
23 
25  : GeneralPostprocessor(parameters), _total_mass(getUserObject<RichardsSumQuantity>("uo"))
26 {
27 }
28 
30 
31 void
33 {
34 }
35 
36 void
38 {
39 }
40 
43 {
44  return _total_mass.getValue();
45 }
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 RichardsSumQuantity
RichardsPlotQuantity(const InputParameters &parameters)
void addRequiredParam(const std::string &name, const std::string &doc_string)
static InputParameters validParams()
static InputParameters validParams()
Real PostprocessorValue
virtual Real getValue() const
returns _total
virtual void initialize() override
const RichardsSumQuantity & _total_mass
the RichardsSumQuantity userobject
registerMooseObject("RichardsApp", RichardsPlotQuantity)
virtual void execute() override
Extracts the value from RichardsSumQuantity userobject.