www.mooseframework.org
Classes | Functions
VolumeHistogram.h File Reference

Go to the source code of this file.

Classes

class  VolumeHistogram
 Compute a histogram of volume fractions binned according to variable values. More...
 

Functions

template<>
InputParameters validParams< VolumeHistogram > ()
 

Function Documentation

Definition at line 24 of file VolumeHistogram.C.

25 {
27  params.addParam<unsigned int>("bin_number", 50, "Number of histogram bins");
28  params.addCoupledVar("variable", "Variable to bin the volume of");
29  params.addRequiredParam<Real>("min_value", "Minimum variable value");
30  params.addRequiredParam<Real>("max_value", "Maximum variable value");
31  return params;
32 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
InputParameters validParams< ElementVectorPostprocessor >()