Classes | Namespaces | Functions
SamplerBase.h File Reference

Go to the source code of this file.


class  SamplerBase
 Base class for VectorPostprocessors that need to do "sampling" of values in the domain. More...


 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.


template<typename T >
InputParameters validParams ()
InputParameters validParams< SamplerBase > ()

Function Documentation

template<typename T >
InputParameters validParams ( )

Definition at line 26 of file SamplerBase.C.

Referenced by validParams< LineFunctionSampler >(), validParams< LineMaterialSamplerBase< Real > >(), validParams< NodalValueSampler >(), validParams< PointSamplerBase >(), and validParams< SideValueSampler >().

27 {
30  MooseEnum sort_options("x y z id");
31  params.addRequiredParam<MooseEnum>("sort_by", sort_options, "What to sort the samples by");
33  return params;
34 }
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...
InputParameters emptyInputParameters()
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37