PorousFlowPermeabilityExponential.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("PorousFlowApp", PorousFlowPermeabilityExponential)
template<>
InputParameters	validParams< PorousFlowPermeabilityExponential > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"PorousFlowApp"	,
		PorousFlowPermeabilityExponential
	)

validParams< PorousFlowPermeabilityExponential >()

template<>

InputParameters validParams< PorousFlowPermeabilityExponential >

(

)

Definition at line 16 of file PorousFlowPermeabilityExponential.C.

{
  InputParameters params = validParams<PorousFlowPermeabilityBase>();
  MooseEnum poroperm_function("log_k ln_k exp_k", "exp_k");
  params.addParam<MooseEnum>("poroperm_function",
                             poroperm_function,
                             "Form of the function relating porosity and permeability. The options "
                             "are: log_k (log k = A phi + B); ln_k (ln k = A phi + B); exp_k (k = "
                             "B exp(A phi)); where k is permeability, phi is porosity, A and B are "
                             "empirical constants.");
  params.addParam<RealTensorValue>("k_anisotropy",
                                   "A tensor to multiply the calculated scalar "
                                   "permeability, in order to obtain anisotropy if "
                                   "required. Defaults to isotropic permeability "
                                   "if not specified.");
  params.addRequiredParam<Real>("A", "Empirical constant; see poroperm_function.");
  params.addRequiredParam<Real>("B", "Empirical constant; see poroperm_function.");
  params.addClassDescription(
      "This Material calculates the permeability tensor from an exponential function of porosity: "
      "k = k_ijk * BB exp(AA phi), where k_ijk is a tensor providing the anisotropy, phi is "
      "porosity, and AA and BB are empirical constants. The user can provide input for the "
      "function expressed in ln k, log k or exponential forms (see poroperm_function).");
  return params;
}