www.mooseframework.org
RichardsRelPermPrimeAux.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 d(relperm)/d(Seff)
11 //
13 
15 
16 template <>
17 InputParameters
19 {
20  InputParameters params = validParams<AuxKernel>();
21  params.addRequiredCoupledVar("seff_var", "The variable that represents the effective saturation");
22  params.addRequiredParam<UserObjectName>(
23  "relperm_UO", "Name of user object that defines the relative permeability.");
24  params.addClassDescription("auxillary variable which is d(relative permeability)/dSeff");
25  return params;
26 }
27 
28 RichardsRelPermPrimeAux::RichardsRelPermPrimeAux(const InputParameters & parameters)
29  : AuxKernel(parameters),
30  _seff_var(coupledValue("seff_var")),
31  _relperm_UO(getUserObject<RichardsRelPerm>("relperm_UO"))
32 {
33 }
34 
35 Real
37 {
38  return _relperm_UO.drelperm(_seff_var[_qp]);
39 }
RichardsRelPerm
Base class for Richards relative permeability classes that provide relative permeability as a functio...
Definition: RichardsRelPerm.h:23
RichardsRelPermPrimeAux::computeValue
virtual Real computeValue()
Definition: RichardsRelPermPrimeAux.C:36
RichardsRelPermPrimeAux::RichardsRelPermPrimeAux
RichardsRelPermPrimeAux(const InputParameters &parameters)
Definition: RichardsRelPermPrimeAux.C:28
validParams< RichardsRelPermPrimeAux >
InputParameters validParams< RichardsRelPermPrimeAux >()
Definition: RichardsRelPermPrimeAux.C:18
RichardsRelPermPrimeAux::_relperm_UO
const RichardsRelPerm & _relperm_UO
userobject that defines relative permeability function
Definition: RichardsRelPermPrimeAux.h:37
RichardsRelPermPrimeAux.h
RichardsRelPerm::drelperm
virtual Real drelperm(Real seff) const =0
derivative of relative permeability wrt effective saturation This must be over-ridden in your derived...
registerMooseObject
registerMooseObject("RichardsApp", RichardsRelPermPrimeAux)
RichardsRelPermPrimeAux
Derivative of relative Permeability wrt effective saturation.
Definition: RichardsRelPermPrimeAux.h:25
RichardsRelPermPrimeAux::_seff_var
const VariableValue & _seff_var
effective saturation
Definition: RichardsRelPermPrimeAux.h:34