GrandPotentialKernelAction.C File Reference

Go to the source code of this file.

Functions
	registerMooseAction ("PhaseFieldApp", GrandPotentialKernelAction, "add_kernel")
template<>
InputParameters	validParams< GrandPotentialKernelAction > ()

Function Documentation

registerMooseAction()

registerMooseAction	(	"PhaseFieldApp"	,
		GrandPotentialKernelAction	,
		"add_kernel"
	)

validParams< GrandPotentialKernelAction >()

template<>

InputParameters validParams< GrandPotentialKernelAction >

(

)

Definition at line 20 of file GrandPotentialKernelAction.C.

{
  InputParameters parameters = validParams<Action>();
  parameters.addClassDescription(
      "Automatically generate most or all of the kernels for the grand potential model");
  parameters.addRequiredParam<std::vector<NonlinearVariableName>>(
      "chemical_potentials", "List of chemical potential variables");
  parameters.addRequiredParam<std::vector<MaterialPropertyName>>(
      "susceptibilities", "List of susceptibilities that correspond to chemical_potentials");
  parameters.addRequiredParam<std::vector<MaterialPropertyName>>(
      "free_energies_gr",
      "List of free energies for each phase. Place in same order as switching_function_names.");
  parameters.addRequiredParam<std::vector<MaterialPropertyName>>(
      "free_energies_w",
      "List of functions for each phase. Length should be length of chemical_potentials * length "
      "of switching_function_names.");
  parameters.addRequiredParam<std::vector<MaterialPropertyName>>(
      "switching_function_names",
      "Switching function materials that provide switching function for free_energies_*.");
  parameters.addRequiredParam<std::vector<MaterialPropertyName>>(
      "mobilities", "Vector of mobilities that must match chemical_potentials");
  parameters.addRequiredParam<unsigned int>("op_num", "specifies the number of grains to create");
  parameters.addRequiredParam<std::string>("var_name_base",
                                           "specifies the base name of the grain variables");
  parameters.addParam<std::vector<NonlinearVariableName>>(
      "additional_ops", "List of any additional order parameters which are not grains");
  parameters.addParam<std::vector<MaterialPropertyName>>("free_energies_op",
                                                         "List of free energies used by additional "
                                                         "order parameters. Places in same order "
                                                         "as switching_function_names.");
  parameters.addParam<MaterialPropertyName>("kappa_gr", "kappa", "The kappa used with the grains");
  parameters.addParam<MaterialPropertyName>(
      "kappa_op", "kappa", "The kappa used with additional_ops");
  parameters.addParam<MaterialPropertyName>(
      "gamma_gr", "gamma", "Name of the gamma used with grains");
  parameters.addParam<MaterialPropertyName>(
      "gamma_op", "gamma", "Name of the gamma used with additional order parameters");
  parameters.addParam<MaterialPropertyName>(
      "gamma_grxop",
      "gamma",
      "Name of the gamma used when grains interact with other order parameters");
  parameters.addParam<MaterialPropertyName>(
      "mobility_name_gr", "L", "Name of mobility to be used with grains");
  parameters.addParam<MaterialPropertyName>(
      "mobility_name_op", "L", "Name of mobility to be used with additional_ops");
  parameters.addParam<bool>("implicit", true, "Whether kernels are implicit or not");
  parameters.addParam<bool>(
      "use_displaced_mesh", false, "Whether to use displaced mesh in the kernels");
  MultiMooseEnum anisotropy("true=1 false=0", "false");
  parameters.addRequiredParam<MultiMooseEnum>(
      "anisotropic", anisotropy, "Whether or not each mobility is anisotropic");
 
  return parameters;
}