www.mooseframework.org
Functions
DerivativeSumMaterial.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< DerivativeSumMaterial > ()
 

Function Documentation

template<>
InputParameters validParams< DerivativeSumMaterial > ( )

Definition at line 14 of file DerivativeSumMaterial.C.

15 {
16  InputParameters params = validParams<DerivativeFunctionMaterialBase>();
17  params.addClassDescription("Meta-material to sum up multiple derivative materials");
18  params.addParam<std::vector<std::string>>(
19  "sum_materials",
20  "Base name of the free energy function (used to name the material properties)");
21  // params.addParam<bool>("third_derivatives", true, "Calculate third derivatoves of the free
22  // energy");
23 
24  // All arguments of the free energies being summed
25  params.addRequiredCoupledVar(
26  "args", "Arguments of the free energy functions being summed - use vector coupling");
27  params.addCoupledVar("displacement_gradients",
28  "Vector of displacement gradient variables (see "
29  "Modules/PhaseField/DisplacementGradients "
30  "action)");
31 
32  // Advanced arguments to construct a sum of the form \f$ c+\gamma\sum_iF_i \f$
33  params.addParam<std::vector<Real>>("prefactor", "Prefactor to multiply the sum term with.");
34  params.addParam<Real>("constant", 0.0, "Constant to be added to the prefactor multiplied sum.");
35  params.addParamNamesToGroup("prefactor constant", "Advanced");
36 
37  return params;
38 }
InputParameters validParams< DerivativeFunctionMaterialBase >()