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

Go to the source code of this file.

Classes

class  NearestPointBase< UserObjectType >
 This UserObject computes averages of a variable storing partial sums for the specified number of intervals in a direction (x,y,z). More...
 

Functions

template<typename UserObjectType >
InputParameters nearestPointBaseValidParams ()
 Because this is a templated base class and template partial specializations are not allowed... More...
 

Function Documentation

template<typename UserObjectType >
InputParameters nearestPointBaseValidParams ( )

Because this is a templated base class and template partial specializations are not allowed...

this class instead defines a new templated function that is templated on the type of UserObject that will be at each nearest point.

If you inherit from this class... then call this function to start your parameters for the new class

Definition at line 35 of file NearestPointBase.h.

36 {
38 
39  params.addRequiredParam<std::vector<Point>>(
40  "points", "Computations will be lumped into values at these points.");
41 
42  // Add in the valid parameters
43  params += validParams<UserObjectType>();
44 
45  return params;
46 }
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 validParams< ElementIntegralVariableUserObject >()