www.mooseframework.org
RichardsRelPerm.h
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 #pragma once
11 
12 #include "GeneralUserObject.h"
13 
14 class RichardsRelPerm;
15 
16 template <>
17 InputParameters validParams<RichardsRelPerm>();
18 
23 class RichardsRelPerm : public GeneralUserObject
24 {
25 public:
26  RichardsRelPerm(const InputParameters & parameters);
27 
28  void initialize();
29  void execute();
30  void finalize();
31 
38  virtual Real relperm(Real seff) const = 0;
39 
46  virtual Real drelperm(Real seff) const = 0;
47 
54  virtual Real d2relperm(Real seff) const = 0;
55 };
56 
RichardsRelPerm
Base class for Richards relative permeability classes that provide relative permeability as a functio...
Definition: RichardsRelPerm.h:23
RichardsRelPerm::relperm
virtual Real relperm(Real seff) const =0
relative permeability as a function of effective saturation This must be over-ridden in your derived ...
RichardsRelPerm::initialize
void initialize()
Definition: RichardsRelPerm.C:29
validParams< RichardsRelPerm >
InputParameters validParams< RichardsRelPerm >()
Definition: RichardsRelPerm.C:16
RichardsRelPerm::drelperm
virtual Real drelperm(Real seff) const =0
derivative of relative permeability wrt effective saturation This must be over-ridden in your derived...
RichardsRelPerm::finalize
void finalize()
Definition: RichardsRelPerm.C:39
RichardsRelPerm::RichardsRelPerm
RichardsRelPerm(const InputParameters &parameters)
Definition: RichardsRelPerm.C:24
RichardsRelPerm::execute
void execute()
Definition: RichardsRelPerm.C:34
RichardsRelPerm::d2relperm
virtual Real d2relperm(Real seff) const =0
second derivative of relative permeability wrt effective saturation This must be over-ridden in your ...