www.mooseframework.org
RichardsSatPrimeAux.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
3 /* */
4 /* All contents are licensed under LGPL V2.1 */
5 /* See LICENSE for full restrictions */
6 /****************************************************************/
7 
8 // This post processor returns the saturation of a region.
9 //
10 #include "RichardsSatPrimeAux.h"
11 
12 template <>
13 InputParameters
15 {
16  InputParameters params = validParams<AuxKernel>();
17  params.addRequiredCoupledVar("seff_var", "Variable that is the effective saturation");
18  params.addRequiredParam<UserObjectName>("sat_UO", "Name of user object that defines saturation.");
19  params.addClassDescription("auxillary variable which is saturation");
20  return params;
21 }
22 
23 RichardsSatPrimeAux::RichardsSatPrimeAux(const InputParameters & parameters)
24  : AuxKernel(parameters),
25  _seff_var(coupledValue("seff_var")),
26  _sat_UO(getUserObject<RichardsSat>("sat_UO"))
27 {
28 }
29 
30 Real
32 {
33  return _sat_UO.dsat(_seff_var[_qp]);
34 }
Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt ef...
Definition: RichardsSat.h:23
const RichardsSat & _sat_UO
User object defining saturation as a function of effective saturation.
const VariableValue & _seff_var
effective saturation
InputParameters validParams< RichardsSatPrimeAux >()
Real dsat(Real) const
derivative of saturation wrt effective saturation
Definition: RichardsSat.C:61
virtual Real computeValue()
RichardsSatPrimeAux(const InputParameters &parameters)