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

Go to the source code of this file.

Classes

class  VariableGradientComponent
 Extract a component from the gradient of a variable. More...
 

Functions

template<>
InputParameters validParams< VariableGradientComponent > ()
 

Function Documentation

Definition at line 18 of file VariableGradientComponent.C.

19 {
20  MooseEnum component("x=0 y=1 z=2");
22  params.addClassDescription(
23  "Creates a field with consisting of one component of a coupled variable.");
24  params.addRequiredCoupledVar("gradient_variable",
25  "The variable from which to compute the gradient component");
26  params.addParam<MooseEnum>("component", component, "The gradient component to compute");
27  return params;
28 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< AuxKernel >()
Definition: AuxKernel.C:30
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
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 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...