www.mooseframework.org
RichardsSat.h
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 #ifndef RICHARDSSAT_H
9 #define RICHARDSSAT_H
10 
11 #include "GeneralUserObject.h"
12 
13 class RichardsSat;
14 
15 template <>
16 InputParameters validParams<RichardsSat>();
17 
23 class RichardsSat : public GeneralUserObject
24 {
25 public:
26  RichardsSat(const InputParameters & parameters);
27 
28  void initialize();
29  void execute();
30  void finalize();
31 
36  Real sat(Real seff) const;
37 
39  Real dsat(Real /*seff*/) const;
40 
41 protected:
43  Real _s_res;
44 
46  Real _sum_s_res;
47 };
48 
49 #endif // RICHARDSSAT_H
Real _sum_s_res
sum of the residual saturations for every phase
Definition: RichardsSat.h:46
void execute()
Definition: RichardsSat.C:46
Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt ef...
Definition: RichardsSat.h:23
Real _s_res
residual saturation for this phase
Definition: RichardsSat.h:43
void initialize()
Definition: RichardsSat.C:41
Real dsat(Real) const
derivative of saturation wrt effective saturation
Definition: RichardsSat.C:61
RichardsSat(const InputParameters &parameters)
Definition: RichardsSat.C:31
InputParameters validParams< RichardsSat >()
Definition: RichardsSat.C:14
void finalize()
Definition: RichardsSat.C:51
Real sat(Real seff) const
saturation as a function of effective saturation
Definition: RichardsSat.C:56