PorousFlowHalfCubicSink.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PorousFlowApp"	,
		PorousFlowHalfCubicSink
	)

validParams< PorousFlowHalfCubicSink >()

template<>

InputParameters validParams< PorousFlowHalfCubicSink >

(

)

Definition at line 17 of file PorousFlowHalfCubicSink.C.

{
  InputParameters params = validParams<PorousFlowSinkPTDefiner>();
  params.addRequiredParam<Real>(
      "max",
      "Maximum of the cubic flux multiplier.  Denote x = porepressure - center (or in the "
      "case of a heat flux with no fluid, x = temperature - center).  Then Flux out is "
      "multiplied by (max/cutoff^3)*(2x + cutoff)(x - cutoff)^2 for cutoff < x < 0.  Flux "
      "out is multiplied by max for x >= 0.  Flux out is multiplied by 0 for x <= cutoff.");
  params.addRequiredParam<FunctionName>("cutoff",
                                        "Cutoff of the cubic (measured in Pa (or K for "
                                        "temperature BCs)).  This needs to be less than "
                                        "zero.");
  params.addRequiredParam<Real>(
      "center", "Center of the cubic flux multiplier (measured in Pa (or K for temperature BCs)).");
  params.addClassDescription("Applies a flux sink to a boundary. The base flux defined by "
                             "PorousFlowSink is multiplied by a cubic.");
  return params;
}