www.mooseframework.org
VolumeHistogram.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef VOLUMEHISTOGRAM_H
16 #define VOLUMEHISTOGRAM_H
17 
19 
20 class VolumeHistogram;
21 
22 template <>
24 
31 {
32 public:
34 
35  virtual void initialize() override;
36  virtual void execute() override;
37  virtual void finalize() override;
38  virtual void threadJoin(const UserObject & y) override;
39 
40 protected:
42  virtual Real computeVolume();
43 
45  const unsigned int _nbins;
46 
48  const Real _min_value;
49 
51  const Real _max_value;
52 
54  const Real _deltaV;
55 
58 
60  unsigned int _qp;
61 
64 
67 };
68 
69 #endif // VOLUMEHISTOGRAM_H
VectorPostprocessorValue & _volume
aggregated volume for the given bin
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Compute a histogram of volume fractions binned according to variable values.
virtual void execute() override
Execute method.
const VariableValue & _value
coupled variable that is being binned
const Real _deltaV
bin width
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< VolumeHistogram >()
const Real _min_value
minimum variable value
unsigned int _qp
current quadrature point - used in computeVolume()
const unsigned int _nbins
number of histogram bins
VolumeHistogram(const InputParameters &parameters)
std::vector< Real > VectorPostprocessorValue
Definition: MooseTypes.h:74
virtual void finalize() override
Finalize.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
virtual void threadJoin(const UserObject &y) override
Must override.
virtual Real computeVolume()
compute the volume contribution at the current quadrature point
Base class for user-specific data.
Definition: UserObject.h:42
const Real _max_value
maximum variable value
VectorPostprocessorValue & _bin_center
value mid point of the bin