www.mooseframework.org
Functions
PorousFlowPermeabilityKozenyCarman.C File Reference

Go to the source code of this file.

Functions

 registerMooseObject ("PorousFlowApp", PorousFlowPermeabilityKozenyCarman)
 
template<>
InputParameters validParams< PorousFlowPermeabilityKozenyCarman > ()
 

Function Documentation

◆ registerMooseObject()

registerMooseObject ( "PorousFlowApp"  ,
PorousFlowPermeabilityKozenyCarman   
)

◆ validParams< PorousFlowPermeabilityKozenyCarman >()

template<>
InputParameters validParams< PorousFlowPermeabilityKozenyCarman > ( )

Definition at line 16 of file PorousFlowPermeabilityKozenyCarman.C.

17 {
18  InputParameters params = validParams<PorousFlowPermeabilityBase>();
19  MooseEnum poroperm_function("kozeny_carman_fd2=0 kozeny_carman_phi0=1", "kozeny_carman_fd2");
20  params.addParam<MooseEnum>(
21  "poroperm_function",
22  poroperm_function,
23  "Function relating porosity and permeability. The options are: kozeny_carman_fd2 = f d^2 "
24  "phi^n/(1-phi)^m (where phi is porosity, f is a scalar constant with typical values "
25  "0.01-0.001, and d is grain size). kozeny_carman_phi0 = k0 (1-phi0)^m/phi0^n * "
26  "phi^n/(1-phi)^m (where phi is porosity, and k0 is the permeability at porosity phi0)");
27  params.addRangeCheckedParam<Real>("k0",
28  "k0 > 0",
29  "The permeability scalar value (usually in "
30  "m^2) at the reference porosity, required for "
31  "kozeny_carman_phi0");
32  params.addParam<RealTensorValue>("k_anisotropy",
33  "A tensor to multiply the calculated scalar "
34  "permeability, in order to obtain anisotropy if "
35  "required. Defaults to isotropic permeability "
36  "if not specified.");
37  params.addRangeCheckedParam<Real>(
38  "phi0", "phi0 > 0 & phi0 < 1", "The reference porosity, required for kozeny_carman_phi0");
39  params.addRangeCheckedParam<Real>(
40  "f", "f > 0", "The multiplying factor, required for kozeny_carman_fd2");
41  params.addRangeCheckedParam<Real>(
42  "d", "d > 0", "The grain diameter, required for kozeny_carman_fd2");
43  params.addRequiredRangeCheckedParam<Real>("n", "n >= 0", "Porosity exponent");
44  params.addRequiredRangeCheckedParam<Real>("m", "m >= 0", "(1-porosity) exponent");
45  params.addClassDescription(
46  "This Material calculates the permeability tensor from a form of the Kozeny-Carman equation, "
47  "k = k_ijk * A * phi^n / (1 - phi)^m, where k_ijk is a tensor providing the anisotropy, phi "
48  "is porosity, n and m are positive scalar constants and A is given in one of the following "
49  "forms: A = k0 * (1 - phi0)^m / phi0^n (where k0 and phi0 are a reference permeability and "
50  "porosity) or A = f * d^2 (where f is a scalar constant and d is grain diameter.");
51  return params;
52 }
validParams< PorousFlowPermeabilityBase >
InputParameters validParams< PorousFlowPermeabilityBase >()
Definition: PorousFlowPermeabilityBase.C:14