BarrierFunctionMaterial.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PhaseFieldApp", BarrierFunctionMaterial)
template<>
InputParameters	validParams< BarrierFunctionMaterial > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PhaseFieldApp"	,
		BarrierFunctionMaterial
	)

validParams< BarrierFunctionMaterial >()

template<>

InputParameters validParams< BarrierFunctionMaterial >

(

)

Definition at line 16 of file BarrierFunctionMaterial.C.

{
  InputParameters params = validParams<OrderParameterFunctionMaterial>();
  params.addClassDescription("Helper material to provide g(eta) and its derivative in a "
                             "polynomial.\nSIMPLE: eta^2*(1-eta)^2\nLOW: eta*(1-eta)"
                             "\nHIGH: eta^2*(1-eta^2)^2");
  MooseEnum g_order("SIMPLE=0 LOW HIGH", "SIMPLE");
  params.addParam<MooseEnum>("g_order", g_order, "Polynomial order of the barrier function g(eta)");
  params.addParam<bool>("well_only",
                        false,
                        "Make the g zero in [0:1] so it only contributes to "
                        "enforcing the eta range and not to the phase "
                        "transformation barrier.");
  params.set<std::string>("function_name") = std::string("g");
  return params;
}