RichardsMaterial.h File Reference

Go to the source code of this file.

Classes
class	RichardsMaterial

Functions
template<>
InputParameters	validParams< RichardsMaterial > ()

Function Documentation

validParams< RichardsMaterial >()

template<>

InputParameters validParams< RichardsMaterial >

(

)

Definition at line 22 of file RichardsMaterial.C.

{
  InputParameters params = validParams<Material>();
 
  params.addRequiredParam<Real>(
      "mat_porosity", "The porosity of the material.  Should be between 0 and 1.  Eg, 0.1");
  params.addCoupledVar("por_change",
                       0,
                       "An auxillary variable describing porosity changes.  "
                       "Porosity = mat_porosity + por_change.  If this is not "
                       "provided, zero is used.");
  params.addRequiredParam<RealTensorValue>("mat_permeability", "The permeability tensor (m^2).");
  params.addCoupledVar("perm_change",
                       "A list of auxillary variable describing permeability "
                       "changes.  There must be 9 of these, corresponding to the "
                       "xx, xy, xz, yx, yy, yz, zx, zy, zz components respectively. "
                       " Permeability = mat_permeability*10^(perm_change).");
  params.addRequiredParam<UserObjectName>(
      "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
  params.addRequiredParam<std::vector<UserObjectName>>(
      "relperm_UO", "List of names of user objects that define relative permeability");
  params.addRequiredParam<std::vector<UserObjectName>>(
      "seff_UO",
      "List of name of user objects that define effective saturation as a function of "
      "pressure list");
  params.addRequiredParam<std::vector<UserObjectName>>(
      "sat_UO",
      "List of names of user objects that define saturation as a function of effective saturation");
  params.addRequiredParam<std::vector<UserObjectName>>(
      "density_UO", "List of names of user objects that define the fluid density");
  params.addRequiredParam<std::vector<UserObjectName>>(
      "SUPG_UO", "List of names of user objects that define the SUPG");
  params.addRequiredParam<std::vector<Real>>(
      "viscosity", "List of viscosity of fluids (Pa.s).  Typical value for water is=1E-3");
  params.addRequiredParam<RealVectorValue>(
      "gravity",
      "Gravitational acceleration (m/s^2) as a vector pointing downwards.  Eg (0,0,-10)");
  // params.addRequiredCoupledVar("pressure_vars", "List of variables that represent the pressure");
  params.addParam<bool>(
      "linear_shape_fcns",
      true,
      "If you are using second-order Lagrange shape functions you need to set this to false.");
  return params;
}