www.mooseframework.org
RichardsSatPrimeAux.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 // This post processor returns the saturation of a region.
11 //
12 #include "RichardsSatPrimeAux.h"
13 
15 
18 {
20  params.addRequiredCoupledVar("seff_var", "Variable that is the effective saturation");
21  params.addRequiredParam<UserObjectName>("sat_UO", "Name of user object that defines saturation.");
22  params.addClassDescription("auxillary variable which is saturation");
23  return params;
24 }
25 
27  : AuxKernel(parameters),
28  _seff_var(coupledValue("seff_var")),
29  _sat_UO(getUserObject<RichardsSat>("sat_UO"))
30 {
31 }
32 
33 Real
35 {
36  return _sat_UO.dsat(_seff_var[_qp]);
37 }
Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt ef...
Definition: RichardsSat.h:19
Derivative of fluid Saturation wrt effective saturation.
const RichardsSat & _sat_UO
User object defining saturation as a function of effective saturation.
Real dsat(Real) const
derivative of saturation wrt effective saturation
Definition: RichardsSat.C:64
static InputParameters validParams()
void addRequiredParam(const std::string &name, const std::string &doc_string)
registerMooseObject("RichardsApp", RichardsSatPrimeAux)
const VariableValue & _seff_var
effective saturation
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual Real computeValue()
RichardsSatPrimeAux(const InputParameters &parameters)
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()