www.mooseframework.org
Public Member Functions | Protected Attributes | List of all members
RichardsSat Class Reference

Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt effective saturation. More...

#include <RichardsSat.h>

Inheritance diagram for RichardsSat:
[legend]

Public Member Functions

 RichardsSat (const InputParameters &parameters)
 
void initialize ()
 
void execute ()
 
void finalize ()
 
Real sat (Real seff) const
 saturation as a function of effective saturation More...
 
Real dsat (Real) const
 derivative of saturation wrt effective saturation More...
 

Protected Attributes

Real _s_res
 residual saturation for this phase More...
 
Real _sum_s_res
 sum of the residual saturations for every phase More...
 

Detailed Description

Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt effective saturation.

Definition at line 23 of file RichardsSat.h.

Constructor & Destructor Documentation

RichardsSat::RichardsSat ( const InputParameters &  parameters)

Definition at line 31 of file RichardsSat.C.

32  : GeneralUserObject(parameters),
33  _s_res(getParam<Real>("s_res")),
34  _sum_s_res(getParam<Real>("sum_s_res"))
35 {
36  if (_sum_s_res < _s_res)
37  mooseError("sum_s_res set to ", _sum_s_res, " but it must obey s_res <= sum_s_res < 1");
38 }
Real _sum_s_res
sum of the residual saturations for every phase
Definition: RichardsSat.h:46
Real _s_res
residual saturation for this phase
Definition: RichardsSat.h:43

Member Function Documentation

Real RichardsSat::dsat ( Real  ) const

derivative of saturation wrt effective saturation

Definition at line 61 of file RichardsSat.C.

Referenced by RichardsSatPrimeAux::computeValue().

61 { return 1.0 - _sum_s_res; }
Real _sum_s_res
sum of the residual saturations for every phase
Definition: RichardsSat.h:46
void RichardsSat::execute ( )

Definition at line 46 of file RichardsSat.C.

47 {
48 }
void RichardsSat::finalize ( )

Definition at line 51 of file RichardsSat.C.

52 {
53 }
void RichardsSat::initialize ( )

Definition at line 41 of file RichardsSat.C.

42 {
43 }
Real RichardsSat::sat ( Real  seff) const

saturation as a function of effective saturation

Parameters
seffeffective saturation

Definition at line 56 of file RichardsSat.C.

Referenced by RichardsSatAux::computeValue().

57 {
58  return _s_res + seff * (1.0 - _sum_s_res);
59 }
Real _sum_s_res
sum of the residual saturations for every phase
Definition: RichardsSat.h:46
Real _s_res
residual saturation for this phase
Definition: RichardsSat.h:43

Member Data Documentation

Real RichardsSat::_s_res
protected

residual saturation for this phase

Definition at line 43 of file RichardsSat.h.

Referenced by RichardsSat(), and sat().

Real RichardsSat::_sum_s_res
protected

sum of the residual saturations for every phase

Definition at line 46 of file RichardsSat.h.

Referenced by dsat(), RichardsSat(), and sat().


The documentation for this class was generated from the following files: