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

Go to the source code of this file.

Classes

class  OrderParameterFunctionMaterial
 Material base class for materials that provide the switching function \( h(\eta) \) or the double well function \( g(\eta) \). More...
 

Functions

template<>
InputParameters validParams< OrderParameterFunctionMaterial > ()
 

Function Documentation

template<>
InputParameters validParams< OrderParameterFunctionMaterial > ( )

Definition at line 11 of file OrderParameterFunctionMaterial.C.

Referenced by validParams< BarrierFunctionMaterial >(), validParams< MixedSwitchingFunctionMaterial >(), and validParams< SwitchingFunctionMaterial >().

12 {
13  InputParameters params = validParams<Material>();
14  params.addCoupledVar("eta", "Order parameter variable");
15  params.addParam<std::string>("function_name", "f", "actual name for f(eta), i.e. 'h' or 'g'");
16  return params;
17 }