Classes | Functions
RichardsPiecewiseLinearSinkFlux.h File Reference

Go to the source code of this file.


class  RichardsPiecewiseLinearSinkFlux
 This postprocessor computes the fluid flux to a RichardsPiecewiseLinearSink. More...


InputParameters validParams< RichardsPiecewiseLinearSinkFlux > ()

Function Documentation

InputParameters validParams< RichardsPiecewiseLinearSinkFlux > ( )

Definition at line 15 of file RichardsPiecewiseLinearSinkFlux.C.

16 {
17  InputParameters params = validParams<SideIntegralVariablePostprocessor>();
18  params.addRequiredParam<bool>(
19  "use_mobility",
20  "If true, then fluxes are multiplied by (density*permeability_nn/viscosity), "
21  "where the '_nn' indicates the component normal to the boundary. In this "
22  "case bare_flux is measured in Pa.s^-1. This can be used in conjunction "
23  "with use_relperm.");
24  params.addRequiredParam<bool>("use_relperm",
25  "If true, then fluxes are multiplied by relative "
26  "permeability. This can be used in conjunction "
27  "with use_mobility");
28  params.addRequiredParam<std::vector<Real>>(
29  "pressures", "Tuple of pressure values. Must be monotonically increasing.");
30  params.addRequiredParam<std::vector<Real>>(
31  "bare_fluxes",
32  "Tuple of flux values (measured in kg.m^-2.s^-1 for use_mobility=false, and "
33  "in Pa.s^-1 if use_mobility=true). This flux is OUT of the medium: hence "
34  "positive values of flux means this will be a SINK, while negative values "
35  "indicate this flux will be a SOURCE. A piecewise-linear fit is performed to "
36  "the (pressure,bare_fluxes) pairs to obtain the flux at any arbitrary "
37  "pressure, and the first or last bare_flux values are used if the quad-point "
38  "pressure falls outside this range.");
39  params.addRequiredParam<UserObjectName>(
40  "richardsVarNames_UO", "The UserObject that holds the list of Richards variable names.");
41  params.addParam<FunctionName>("multiplying_fcn",
42  1.0,
43  "The flux will be multiplied by this spatially-and-temporally "
44  "varying function. This is useful if the boundary is a moving "
45  "boundary controlled by RichardsExcav.");
46  params.addClassDescription("Records the fluid flow into a sink (positive values indicate fluid "
47  "is flowing from porespace into the sink).");
48  return params;
49 }