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

Go to the source code of this file.

Classes

class  ParsedMaterialBase
 Helper class for ParsedMaterial and DerivativeParsedMaterial to declare and read the input parameters. More...
 

Functions

template<>
InputParameters validParams< ParsedMaterialBase > ()
 

Function Documentation

template<>
InputParameters validParams< ParsedMaterialBase > ( )

Definition at line 11 of file ParsedMaterialBase.C.

Referenced by validParams< DerivativeParsedMaterial >(), and validParams< ParsedMaterial >().

12 {
13  InputParameters params = emptyInputParameters();
14  params.addCoupledVar("args", "Arguments of F() - use vector coupling");
15 
16  // Constants and their values
17  params.addParam<std::vector<std::string>>(
18  "constant_names",
19  std::vector<std::string>(),
20  "Vector of constants used in the parsed function (use this for kB etc.)");
21  params.addParam<std::vector<std::string>>(
22  "constant_expressions",
23  std::vector<std::string>(),
24  "Vector of values for the constants in constant_names (can be an FParser expression)");
25 
26  // Variables with applied tolerances and their tolerance values
27  params.addParam<std::vector<std::string>>("tol_names",
28  std::vector<std::string>(),
29  "Vector of variable names to be protected from "
30  "being 0 or 1 within a tolerance (needed for log(c) "
31  "and log(1-c) terms)");
32  params.addParam<std::vector<Real>>("tol_values",
33  std::vector<Real>(),
34  "Vector of tolerance values for the variables in tol_names");
35 
36  // Material properties
37  params.addParam<std::vector<std::string>>(
38  "material_property_names",
39  std::vector<std::string>(),
40  "Vector of material properties used in the parsed function");
41 
42  // Function expression
43  params.addRequiredParam<std::string>("function",
44  "FParser function expression for the phase free energy");
45 
46  return params;
47 }