PorousFlowRelativePermeabilityBase.h File Reference

Go to the source code of this file.

Classes
class	PorousFlowRelativePermeabilityBase
	Base class for PorousFlow relative permeability materials. More...

Functions
template<>
InputParameters	validParams< PorousFlowRelativePermeabilityBase > ()

Function Documentation

validParams< PorousFlowRelativePermeabilityBase >()

template<>

InputParameters validParams< PorousFlowRelativePermeabilityBase >

(

)

Definition at line 14 of file PorousFlowRelativePermeabilityBase.C.

{
  InputParameters params = validParams<PorousFlowMaterialBase>();
  params.addRangeCheckedParam<Real>(
      "scaling", 1.0, "scaling>=0", "Relative permeability is multiplied by this factor");
  params.addRangeCheckedParam<Real>(
      "s_res",
      0,
      "s_res >= 0 & s_res < 1",
      "The residual saturation of the phase j. Must be between 0 and 1");
  params.addRangeCheckedParam<Real>(
      "sum_s_res",
      0,
      "sum_s_res >= 0 & sum_s_res < 1",
      "Sum of residual saturations over all phases.  Must be between 0 and 1");
  params.addPrivateParam<std::string>("pf_material_type", "relative_permeability");
  params.addClassDescription("Base class for PorousFlow relative permeability materials");
  return params;
}

Referenced by validParams< PorousFlowRelativePermeabilityBC >(), validParams< PorousFlowRelativePermeabilityBW >(), validParams< PorousFlowRelativePermeabilityConst >(), validParams< PorousFlowRelativePermeabilityCorey >(), validParams< PorousFlowRelativePermeabilityFLAC >(), and validParams< PorousFlowRelativePermeabilityVG >().