PolycrystalElasticDrivingForceAction.h File Reference

Go to the source code of this file.

Classes
class	PolycrystalElasticDrivingForceAction
	Action that adds the elastic driving force for each order parameter. More...

Functions
template<>
InputParameters	validParams< PolycrystalElasticDrivingForceAction > ()

Function Documentation

validParams< PolycrystalElasticDrivingForceAction >()

template<>

InputParameters validParams< PolycrystalElasticDrivingForceAction >

(

)

Definition at line 19 of file PolycrystalElasticDrivingForceAction.C.

{
  InputParameters params = validParams<Action>();
  params.addClassDescription(
      "Action that addes the elastic driving force for each order parameter");
  params.addRequiredParam<unsigned int>("op_num", "specifies the number of grains to create");
  params.addRequiredParam<std::string>("var_name_base", "specifies the base name of the variables");
  params.addParam<bool>(
      "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
  params.addParam<std::string>("base_name",
                               "Optional parameter that allows the user to define "
                               "multiple mechanics material systems on the same "
                               "block, i.e. for multiple phases");
  return params;
}