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

Go to the source code of this file.

Classes

class  SphericalAverage
 Compute a spherical average of a variableas a function of radius throughout the simulation domain. More...
 

Functions

template<>
InputParameters validParams< SphericalAverage > ()
 

Function Documentation

Definition at line 24 of file SphericalAverage.C.

25 {
27  params.addParam<unsigned int>("bin_number", 50, "Number of histogram bins");
28  params.addCoupledVar("variable", "Variables to average radially");
29  params.addRequiredParam<Real>("radius", "Radius to average out to");
30  params.addParam<Real>(
31  "empty_bin_value", 0.0, "Value to assign to bins into which no datapoints fall");
32  return params;
33 }
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 >()