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 24 of file RichardsSat.h.

Constructor & Destructor Documentation

◆ RichardsSat()

RichardsSat::RichardsSat ( const InputParameters & parameters )

Definition at line 35 of file RichardsSat.C.

   : GeneralUserObject(parameters),
     _s_res(getParam<Real>("s_res")),
     _sum_s_res(getParam<Real>("sum_s_res"))
 {
   if (_sum_s_res < _s_res)
     mooseError("sum_s_res set to ", _sum_s_res, " but it must obey s_res <= sum_s_res < 1");
 }

Member Function Documentation

◆ dsat()

Real RichardsSat::dsat ( Real ) const

derivative of saturation wrt effective saturation

Definition at line 65 of file RichardsSat.C.

65 { return 1.0 - _sum_s_res; }

Referenced by RichardsSatPrimeAux::computeValue().

◆ execute()

void RichardsSat::execute ( )

Definition at line 50 of file RichardsSat.C.

51 {

52 }

◆ finalize()

void RichardsSat::finalize ( )

Definition at line 55 of file RichardsSat.C.

56 {

57 }

◆ initialize()

void RichardsSat::initialize ( )

Definition at line 45 of file RichardsSat.C.

46 {

47 }

◆ sat()

Real RichardsSat::sat ( Real seff ) const

saturation as a function of effective saturation

Parameters

seff	effective saturation

Definition at line 60 of file RichardsSat.C.

 {
   return _s_res + seff * (1.0 - _sum_s_res);
 }

Referenced by RichardsSatAux::computeValue().

Member Data Documentation

◆ _s_res

Real RichardsSat::_s_res

protected

residual saturation for this phase

Definition at line 44 of file RichardsSat.h.

Referenced by RichardsSat(), and sat().

◆ _sum_s_res

Real RichardsSat::_sum_s_res

protected

sum of the residual saturations for every phase

Definition at line 47 of file RichardsSat.h.

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

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

richards/include/userobjects/RichardsSat.h
richards/src/userobjects/RichardsSat.C

Public Member Functions

Protected Attributes