https://mooseframework.inl.gov
SideAverageMaterialProperty.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 
14 
15 template <bool is_ad>
18 {
20  params.addClassDescription("Computes the average of a material property over a side set.");
21  return params;
22 }
23 
24 template <bool is_ad>
26  const InputParameters & parameters)
27  : SideIntegralMaterialPropertyTempl<is_ad>(parameters), _area(0.0)
28 {
29 }
30 
31 template <bool is_ad>
32 void
34 {
36  _area = 0.0;
37 }
38 
39 template <bool is_ad>
40 void
42 {
44 
45  _area += this->_current_side_volume;
46 }
47 
48 template <bool is_ad>
49 Real
51 {
52  return _integral_value / _area;
53 }
54 
55 template <bool is_ad>
56 void
58 {
61 }
62 
63 template <bool is_ad>
64 void
66 {
68 
69  const auto & pps = static_cast<const SideAverageMaterialPropertyTempl<is_ad> &>(y);
70  _area += pps._area;
71 }
72 
Computes the integral of a material property over a side set.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void gatherSum(T &value)
Gather the parallel sum of the variable passed in.
Definition: UserObject.h:126
registerMooseObject("MooseApp", SideAverageMaterialProperty)
virtual void finalize() override
This is called after execute() and after threadJoin()! This is probably where you want to do MPI comm...
virtual void threadJoin(const UserObject &y) override
Must override.
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.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
SideAverageMaterialPropertyTempl(const InputParameters &parameters)
virtual void execute() override
Execute method.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Computes the average of a material property over a side set.
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...
virtual void execute() override
Execute method.
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Base class for user-specific data.
Definition: UserObject.h:40