Q2PBorehole.C File Reference

Go to the source code of this file.

Functions
	registerMooseObject ("RichardsApp", Q2PBorehole)
template<>
InputParameters	validParams< Q2PBorehole > ()

Function Documentation

registerMooseObject()

registerMooseObject	(	"RichardsApp"	,
		Q2PBorehole
	)

validParams< Q2PBorehole >()

template<>

InputParameters validParams< Q2PBorehole >

(

)

Definition at line 17 of file Q2PBorehole.C.

{
  InputParameters params = validParams<PeacemanBorehole>();
  params.addRequiredParam<UserObjectName>(
      "fluid_density",
      "A RichardsDensity UserObject that defines the fluid density as a function of pressure.");
  params.addRequiredParam<UserObjectName>(
      "fluid_relperm",
      "A RichardsRelPerm UserObject (eg RichardsRelPermPower) that defines the "
      "fluid relative permeability as a function of the saturation Variable.");
  params.addRequiredCoupledVar("other_var",
                               "The other variable in the 2-phase system.  If "
                               "Variable=porepressure, the other_var=saturation, and "
                               "vice-versa.");
  params.addRequiredParam<bool>("var_is_porepressure",
                                "This flag is needed to correctly calculate the Jacobian entries.  "
                                "If set to true, this Sink will extract fluid from the phase with "
                                "porepressure as its Variable (usually the liquid phase).  If set "
                                "to false, this Sink will extract fluid from the phase with "
                                "saturation as its variable (usually the gas phase)");
  params.addRequiredParam<Real>("fluid_viscosity", "The fluid dynamic viscosity");
  params.addClassDescription("Approximates a borehole in the mesh with given bottomhole pressure, "
                             "and radii using a number of point sinks whose positions are read "
                             "from a file.  This DiracKernel is for use by Q2P models");
  return params;
}