PorousFlowDictator.C File Reference

Go to the source code of this file.

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

Function Documentation

registerMooseObject()

registerMooseObject	(	"PorousFlowApp"	,
		PorousFlowDictator
	)

validParams< PorousFlowDictator >()

template<>

InputParameters validParams< PorousFlowDictator >

(

)

Definition at line 19 of file PorousFlowDictator.C.

{
  InputParameters params = validParams<GeneralUserObject>();
  params.addClassDescription("Holds information on the PorousFlow variable names");
  params.addRequiredCoupledVar("porous_flow_vars",
                               "List of primary variables that are used in the PorousFlow "
                               "simulation.  Jacobian entries involving derivatives wrt these "
                               "variables will be computed.  In single-phase models you will just "
                               "have one (eg \'pressure\'), in two-phase models you will have two "
                               "(eg \'p_water p_gas\', or \'p_water s_water\'), etc.");
  params.addRequiredParam<unsigned int>("number_fluid_phases",
                                        "The number of fluid phases in the simulation");
  params.addRequiredParam<unsigned int>("number_fluid_components",
                                        "The number of fluid components in the simulation");
  params.addParam<unsigned int>("number_aqueous_equilibrium",
                                0,
                                "The number of secondary species in the aqueous-equilibrium "
                                "reaction system.  (Leave as zero if the simulation does not "
                                "involve chemistry)");
  params.addParam<unsigned int>("number_aqueous_kinetic",
                                0,
                                "The number of secondary species in the aqueous-kinetic reaction "
                                "system involved in precipitation and dissolution.  (Leave as zero "
                                "if the simulation does not involve chemistry)");
  params.addParam<unsigned int>("aqueous_phase_number",
                                0,
                                "The fluid phase number of the aqueous phase in which the "
                                "equilibrium and kinetic chemical reactions occur");
  return params;
}