www.mooseframework.org
RichardsSeffAux.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 effective saturation of a region.
11 //
12 #include "RichardsSeffAux.h"
13 
14 registerMooseObject("RichardsApp", RichardsSeffAux);
15 
18 {
20  params.addRequiredCoupledVar("pressure_vars", "List of variables that represent the pressure");
21  params.addRequiredParam<UserObjectName>("seff_UO",
22  "Name of user object that defines effective saturation.");
23  params.addClassDescription("auxillary variable which is effective saturation");
24  return params;
25 }
26 
28  : AuxKernel(parameters),
29  _seff_UO(getUserObject<RichardsSeff>("seff_UO")),
30  _pressure_vals(coupledValues("pressure_vars"))
31 {
32 }
33 
34 Real
36 {
38 }
Base class for effective saturation as a function of porepressure(s) The functions seff...
Definition: RichardsSeff.h:18
RichardsSeffAux(const InputParameters &parameters)
virtual Real computeValue()
void addRequiredParam(const std::string &name, const std::string &doc_string)
const RichardsSeff & _seff_UO
The user object that defines effective saturation as function of porepressure (or porepressures in th...
virtual Real seff(std::vector< const VariableValue *> p, unsigned int qp) const =0
effective saturation as a function of porepressure(s) at given quadpoint of the element ...
static InputParameters validParams()
const std::vector< const VariableValue * > _pressure_vals
the porepressure values (this will be length N where N is the number of arguments that the _seff_UO r...
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
registerMooseObject("RichardsApp", RichardsSeffAux)
void addClassDescription(const std::string &doc_string)
static InputParameters validParams()
Calculates effective saturation for a specified variable.