www.mooseframework.org
Functions
Q2PAction.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< Q2PAction > ()
 

Function Documentation

template<>
InputParameters validParams< Q2PAction > ( )

Definition at line 16 of file Q2PAction.C.

17 {
18  MooseEnum orders("CONSTANT FIRST SECOND THIRD FOURTH", "FIRST");
19 
20  InputParameters params = validParams<Action>();
21  params.addRequiredParam<NonlinearVariableName>("porepressure", "The porepressure variable");
22  params.addRequiredParam<NonlinearVariableName>("saturation", "The water saturation variable");
23  params.addRequiredParam<UserObjectName>(
24  "water_density",
25  "A RichardsDensity UserObject that defines the water density as a function of porepressure.");
26  params.addRequiredParam<UserObjectName>(
27  "water_relperm",
28  "A RichardsRelPerm UserObject that defines the water relative permeability "
29  "as a function of water saturation (eg RichardsRelPermPower).");
30  params.addParam<UserObjectName>(
31  "water_relperm_for_diffusion",
32  "A RichardsRelPerm UserObject that defines the water relative permeability as a function of "
33  "water saturation that will be used in the diffusivity Kernel (eg RichardsRelPermPower). If "
34  "not given, water_relperm will be used instead, which is the most common use-case.");
35  params.addRequiredParam<Real>("water_viscosity", "The water viscosity");
36  params.addRequiredParam<UserObjectName>(
37  "gas_density",
38  "A RichardsDensity UserObject that defines the gas density as a function of porepressure.");
39  params.addRequiredParam<UserObjectName>(
40  "gas_relperm",
41  "A RichardsRelPerm UserObject that defines the gas relative permeability as a "
42  "function of water saturation (eg Q2PRelPermPowerGas).");
43  params.addRequiredParam<Real>("gas_viscosity", "The gas viscosity");
44  params.addRequiredParam<Real>("diffusivity", "The diffusivity");
45  params.addParam<std::vector<OutputName>>("output_nodal_masses_to",
46  "Output Nodal masses to this Output object. If you "
47  "don't want any outputs, don't input anything here");
48  params.addParam<std::vector<OutputName>>(
49  "output_total_masses_to",
50  "Output total water and gas mass to this Output object. If you "
51  "don't want any outputs, don't input anything here");
52  params.addParam<bool>("save_gas_flux_in_Q2PGasFluxResidual",
53  false,
54  "Save the residual for the "
55  "Q2PPorepressureFlux into "
56  "the AuxVariable called "
57  "Q2PGasFluxResidual");
58  params.addParam<bool>("save_water_flux_in_Q2PWaterFluxResidual",
59  false,
60  "Save the residual for the Q2PSaturationFlux into the AuxVariable called "
61  "Q2PWaterFluxResidual");
62  params.addParam<bool>("save_gas_Jacobian_in_Q2PGasJacobian",
63  false,
64  "Save the diagonal component of the Q2PPorepressureFlux Jacobian into the "
65  "AuxVariable called Q2PGasJacobian");
66  params.addParam<bool>("save_water_Jacobian_in_Q2PWaterJacobian",
67  false,
68  "Save the diagonal component of the Q2PSaturationFlux Jacobian into the "
69  "AuxVariable called Q2PWaterJacobian");
70  params.addParam<MooseEnum>("ORDER",
71  orders,
72  "The order for the porepressure and saturation: " +
73  orders.getRawNames() +
74  " (only needed if you're calculating masses)");
75  return params;
76 }