PorousFlowFluidMass.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PorousFlowApp"	,
		PorousFlowFluidMass
	)

validParams< PorousFlowFluidMass >()

template<>

InputParameters validParams< PorousFlowFluidMass >

(

)

Definition at line 20 of file PorousFlowFluidMass.C.

{
  InputParameters params = validParams<ElementIntegralPostprocessor>();
  params.addParam<unsigned int>(
      "fluid_component",
      0,
      "The index corresponding to the fluid component that this Postprocessor acts on");
  params.addRequiredParam<UserObjectName>(
      "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names.");
  params.addParam<std::vector<unsigned int>>("phase",
                                             "The index of the fluid phase that this "
                                             "Postprocessor is restricted to.  Multiple "
                                             "indices can be entered");
  params.addRangeCheckedParam<Real>("saturation_threshold",
                                    1.0,
                                    "saturation_threshold >= 0 & saturation_threshold <= 1",
                                    "The saturation threshold below which the mass is calculated "
                                    "for a specific phase. Default is 1.0. Note: only one "
                                    "phase_index can be entered");
  params.addParam<unsigned int>("kernel_variable_number",
                                0,
                                "The PorousFlow variable number (according to the dictator) of "
                                "the fluid-mass kernel.  This is required only in the unusual "
                                "situation where a variety of different finite-element "
                                "interpolation schemes are employed in the simulation");
  params.set<bool>("use_displaced_mesh") = true;
  params.addClassDescription("Calculates the mass of a fluid component in a region");
  return params;
}