https://mooseframework.inl.gov
Loading...
Searching...
No Matches
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
11
13
16{
18 params.addClassDescription("Computes the average of a function over a volume.");
19 return params;
20}
21
26
27void
33
34void
40
41Real
46
47void
53
54void
56{
58 const auto & pps = static_cast<const FunctionElementAverage &>(y);
59 _volume += pps._volume;
60}
registerMooseObject("MooseApp", FunctionElementAverage)
virtual void execute() override
Execute method.
virtual void threadJoin(const UserObject &y) override
Must override.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
const Real & _current_elem_volume
The current element volume (available during execute())
Computes the average of a function over a volume.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
virtual void finalize() override
This is called after execute() and after threadJoin()! This is probably where you want to do MPI comm...
virtual void execute() override
Execute method.
static InputParameters validParams()
virtual void threadJoin(const UserObject &y) override
Must override.
FunctionElementAverage(const InputParameters &parameters)
Integrates a function over elements.
static InputParameters validParams()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
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.
void gatherSum(T &value)
Gather the parallel sum of the variable passed in.
Base class for user-specific data.
Definition UserObject.h:20