www.mooseframework.org
Functions
VectorMagnitudeAux.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< VectorMagnitudeAux > ()
 

Function Documentation

Definition at line 21 of file VectorMagnitudeAux.C.

22 {
24  params.addClassDescription("Creates a field representing the magnitude of three coupled "
25  "variables using an Euclidean norm.");
26  params.addRequiredCoupledVar("x", "x-component of the vector");
27  params.addCoupledVar("y", "y-component of the vector");
28  params.addCoupledVar("z", "z-component of the vector");
29 
30  return params;
31 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< AuxKernel >()
Definition: AuxKernel.C:30
void addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
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...