www.mooseframework.org
Functions
RichardsMaterial.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< RichardsMaterial > ()
 

Function Documentation

template<>
InputParameters validParams< RichardsMaterial > ( )

Definition at line 18 of file RichardsMaterial.C.

19 {
20  InputParameters params = validParams<Material>();
21 
22  params.addRequiredParam<Real>(
23  "mat_porosity", "The porosity of the material. Should be between 0 and 1. Eg, 0.1");
24  params.addCoupledVar("por_change",
25  0,
26  "An auxillary variable describing porosity changes. "
27  "Porosity = mat_porosity + por_change. If this is not "
28  "provided, zero is used.");
29  params.addRequiredParam<RealTensorValue>("mat_permeability", "The permeability tensor (m^2).");
30  params.addCoupledVar("perm_change",
31  "A list of auxillary variable describing permeability "
32  "changes. There must be 9 of these, corresponding to the "
33  "xx, xy, xz, yx, yy, yz, zx, zy, zz components respectively. "
34  " Permeability = mat_permeability*10^(perm_change).");
35  params.addRequiredParam<UserObjectName>(
36  "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
37  params.addRequiredParam<std::vector<UserObjectName>>(
38  "relperm_UO", "List of names of user objects that define relative permeability");
39  params.addRequiredParam<std::vector<UserObjectName>>(
40  "seff_UO",
41  "List of name of user objects that define effective saturation as a function of "
42  "pressure list");
43  params.addRequiredParam<std::vector<UserObjectName>>(
44  "sat_UO",
45  "List of names of user objects that define saturation as a function of effective saturation");
46  params.addRequiredParam<std::vector<UserObjectName>>(
47  "density_UO", "List of names of user objects that define the fluid density");
48  params.addRequiredParam<std::vector<UserObjectName>>(
49  "SUPG_UO", "List of names of user objects that define the SUPG");
50  params.addRequiredParam<std::vector<Real>>(
51  "viscosity", "List of viscosity of fluids (Pa.s). Typical value for water is=1E-3");
52  params.addRequiredParam<RealVectorValue>(
53  "gravity",
54  "Gravitational acceleration (m/s^2) as a vector pointing downwards. Eg (0,0,-10)");
55  // params.addRequiredCoupledVar("pressure_vars", "List of variables that represent the pressure");
56  params.addParam<bool>(
57  "linear_shape_fcns",
58  true,
59  "If you are using second-order Lagrange shape functions you need to set this to false.");
60  return params;
61 }