www.mooseframework.org
MaterialAuxBase.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 // MOOSE includes
16 #include "MaterialAuxBase.h"
17 
18 template <>
20 validParams<MaterialAuxBase<>>()
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...