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

Go to the source code of this file.

Classes

class  MaterialAuxBase< T >
 A base class for the various Material related AuxKernal objects. More...
 
class  MaterialAuxBase< T >
 A base class for the various Material related AuxKernal objects. More...
 

Functions

template<>
InputParameters validParams< MaterialAuxBase<> > ()
 

Function Documentation

Definition at line 20 of file MaterialAuxBase.C.

21 {
23  params.addRequiredParam<MaterialPropertyName>("property", "The scalar material property name");
24  params.addParam<Real>(
25  "factor", 1, "The factor by which to multiply your material property for visualization");
26  params.addParam<Real>(
27  "offset", 0, "The offset to add to your material property for visualization");
28  return params;
29 }
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< AuxKernel >()
Definition: AuxKernel.C:30
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...