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