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

Go to the source code of this file.

Classes

class  ElementLpNormAux
 Compute an elemental field variable (single value per element) equal to the Lp-norm of a coupled Variable. More...
 

Functions

template<>
InputParameters validParams< ElementLpNormAux > ()
 

Function Documentation

Definition at line 22 of file ElementLpNormAux.C.

Referenced by validParams< ElementL2ErrorFunctionAux >().

23 {
25  params.addClassDescription("Compute an elemental field variable (single value per element) equal "
26  "to the Lp-norm of a coupled Variable.");
27  params.addRangeCheckedParam<Real>("p", 2.0, "p>=1", "The exponent used in the norm.");
28  params.addRequiredCoupledVar("coupled_variable", "The variable to compute the norm of.");
29  return params;
30 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< AuxKernel >()
Definition: AuxKernel.C:30
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)