https://mooseframework.inl.gov
FunctionElementAverage.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 
10 #include "FunctionElementAverage.h"
11 
13 
16 {
18  params.addClassDescription("Computes the average of a function over a volume.");
19  return params;
20 }
21 
23  : FunctionElementIntegral(parameters)
24 {
25 }
26 
27 void
29 {
31  _volume = 0;
32 }
33 
34 void
36 {
39 }
40 
41 Real
43 {
44  return _integral_value / _volume;
45 }
46 
47 void
49 {
52 }
53 
54 void
56 {
58  const auto & pps = static_cast<const FunctionElementAverage &>(y);
59  _volume += pps._volume;
60 }
Computes the average of a function over a volume.
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
static InputParameters validParams()
registerMooseObject("MooseApp", FunctionElementAverage)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
const Real & _current_elem_volume
The current element volume (available during execute())
virtual void threadJoin(const UserObject &y) override
Must override.
void gatherSum(T &value)
Gather the parallel sum of the variable passed in.
Definition: UserObject.h:126
virtual void execute() override
Execute method.
virtual void finalize() override
This is called after execute() and after threadJoin()! This is probably where you want to do MPI comm...
FunctionElementAverage(const InputParameters &parameters)
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Integrates a function over elements.
static InputParameters validParams()
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual void execute() override
Execute method.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
Base class for user-specific data.
Definition: UserObject.h:40
virtual void threadJoin(const UserObject &y) override
Must override.