PorousFlowPolyLineSink.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PorousFlowApp"	,
		PorousFlowPolyLineSink
	)

validParams< PorousFlowPolyLineSink >()

template<>

InputParameters validParams< PorousFlowPolyLineSink >

(

)

Definition at line 16 of file PorousFlowPolyLineSink.C.

{
  InputParameters params = validParams<PorousFlowLineSink>();
  params.addRequiredParam<std::vector<Real>>(
      "p_or_t_vals",
      "Tuple of pressure (or temperature) values.  Must be monotonically increasing.");
  params.addRequiredParam<std::vector<Real>>(
      "fluxes",
      "Tuple of flux values (measured in kg.m^-1.s^-1 if no 'use_*' are employed).  "
      "These flux values are multiplied by the line-segment length to achieve a flux in "
      "kg.s^-1.  A piecewise-linear fit is performed to the (p_or_t_vals,flux) pairs to "
      "obtain the flux at any arbitrary pressure (or temperature).  If a quad-point "
      "pressure is less than the first pressure value, the first flux value is used.  If "
      "quad-point pressure exceeds the final pressure value, the final flux value is "
      "used.  This flux is OUT of the medium: hence positive values of flux means this "
      "will be a SINK, while negative values indicate this flux will be a SOURCE.");
  params.addClassDescription(
      "Approximates a polyline sink by using a number of point sinks with "
      "given weighting whose positions are read from a file.  NOTE: if you are using "
      "PorousFlowPorosity that depends on volumetric strain, you should set "
      "strain_at_nearest_qp=true in your GlobalParams, to ensure the nodal Porosity Material uses "
      "the volumetric strain at the Dirac quadpoints, and can therefore be computed");
  return params;
}