www.mooseframework.org
Classes | Functions
PorousFlowFluidMass.h File Reference

Go to the source code of this file.

Classes

class  PorousFlowFluidMass
 Postprocessor produces the mass of a given fluid component in a region. More...
 

Functions

template<>
InputParameters validParams< PorousFlowFluidMass > ()
 

Function Documentation

template<>
InputParameters validParams< PorousFlowFluidMass > ( )

Definition at line 17 of file PorousFlowFluidMass.C.

18 {
19  InputParameters params = validParams<ElementIntegralPostprocessor>();
20  params.addParam<unsigned int>(
21  "fluid_component",
22  0,
23  "The index corresponding to the fluid component that this Postprocessor acts on");
24  params.addRequiredParam<UserObjectName>(
25  "PorousFlowDictator", "The UserObject that holds the list of PorousFlow variable names.");
26  params.addParam<std::vector<unsigned int>>("phase",
27  "The index of the fluid phase that this "
28  "Postprocessor is restricted to. Multiple "
29  "indices can be entered");
30  params.addRangeCheckedParam<Real>("saturation_threshold",
31  1.0,
32  "saturation_threshold >= 0 & saturation_threshold <= 1",
33  "The saturation threshold below which the mass is calculated "
34  "for a specific phase. Default is 1.0. Note: only one "
35  "phase_index can be entered");
36  params.addParam<unsigned int>("kernel_variable_number",
37  0,
38  "The PorousFlow variable number (according to the dictator) of "
39  "the fluid-mass kernel. This is required only in the unusual "
40  "situation where a variety of different finite-element "
41  "interpolation schemes are employed in the simulation");
42  params.set<bool>("use_displaced_mesh") = true;
43  params.addClassDescription("Calculates the mass of a fluid component in a region");
44  return params;
45 }