Q2PAction.C File Reference

Go to the source code of this file.

Functions
	registerMooseAction ("RichardsApp", Q2PAction, "add_kernel")
	registerMooseAction ("RichardsApp", Q2PAction, "add_aux_variable")
	registerMooseAction ("RichardsApp", Q2PAction, "add_function")
	registerMooseAction ("RichardsApp", Q2PAction, "add_postprocessor")
template<>
InputParameters	validParams< Q2PAction > ()

Function Documentation

registerMooseAction() [1/4]

registerMooseAction	(	"RichardsApp"	,
		Q2PAction	,
		"add_aux_variable"
	)

registerMooseAction() [2/4]

registerMooseAction	(	"RichardsApp"	,
		Q2PAction	,
		"add_function"
	)

registerMooseAction() [3/4]

registerMooseAction	(	"RichardsApp"	,
		Q2PAction	,
		"add_kernel"
	)

registerMooseAction() [4/4]

registerMooseAction	(	"RichardsApp"	,
		Q2PAction	,
		"add_postprocessor"
	)

validParams< Q2PAction >()

template<>

InputParameters validParams< Q2PAction >

(

)

Definition at line 28 of file Q2PAction.C.

{
  MooseEnum orders("CONSTANT FIRST SECOND THIRD FOURTH", "FIRST");
 
  InputParameters params = validParams<Action>();
  params.addRequiredParam<NonlinearVariableName>("porepressure", "The porepressure variable");
  params.addRequiredParam<NonlinearVariableName>("saturation", "The water saturation variable");
  params.addRequiredParam<UserObjectName>(
      "water_density",
      "A RichardsDensity UserObject that defines the water density as a function of porepressure.");
  params.addRequiredParam<UserObjectName>(
      "water_relperm",
      "A RichardsRelPerm UserObject that defines the water relative permeability "
      "as a function of water saturation (eg RichardsRelPermPower).");
  params.addParam<UserObjectName>(
      "water_relperm_for_diffusion",
      "A RichardsRelPerm UserObject that defines the water relative permeability as a function of "
      "water saturation that will be used in the diffusivity Kernel (eg RichardsRelPermPower).  If "
      "not given, water_relperm will be used instead, which is the most common use-case.");
  params.addRequiredParam<Real>("water_viscosity", "The water viscosity");
  params.addRequiredParam<UserObjectName>(
      "gas_density",
      "A RichardsDensity UserObject that defines the gas density as a function of porepressure.");
  params.addRequiredParam<UserObjectName>(
      "gas_relperm",
      "A RichardsRelPerm UserObject that defines the gas relative permeability as a "
      "function of water saturation (eg Q2PRelPermPowerGas).");
  params.addRequiredParam<Real>("gas_viscosity", "The gas viscosity");
  params.addRequiredParam<Real>("diffusivity", "The diffusivity");
  params.addParam<std::vector<OutputName>>("output_nodal_masses_to",
                                           "Output Nodal masses to this Output object.  If you "
                                           "don't want any outputs, don't input anything here");
  params.addParam<std::vector<OutputName>>(
      "output_total_masses_to",
      "Output total water and gas mass to this Output object.  If you "
      "don't want any outputs, don't input anything here");
  params.addParam<bool>("save_gas_flux_in_Q2PGasFluxResidual",
                        false,
                        "Save the residual for the "
                        "Q2PPorepressureFlux into "
                        "the AuxVariable called "
                        "Q2PGasFluxResidual");
  params.addParam<bool>("save_water_flux_in_Q2PWaterFluxResidual",
                        false,
                        "Save the residual for the Q2PSaturationFlux into the AuxVariable called "
                        "Q2PWaterFluxResidual");
  params.addParam<bool>("save_gas_Jacobian_in_Q2PGasJacobian",
                        false,
                        "Save the diagonal component of the Q2PPorepressureFlux Jacobian into the "
                        "AuxVariable called Q2PGasJacobian");
  params.addParam<bool>("save_water_Jacobian_in_Q2PWaterJacobian",
                        false,
                        "Save the diagonal component of the Q2PSaturationFlux Jacobian into the "
                        "AuxVariable called Q2PWaterJacobian");
  params.addParam<MooseEnum>(
      "ORDER",
      orders,
      "The order for the porepressure and saturation: " + orders.getRawNames() +
          " (only needed if you're calculating masses)");
  return params;
}