www.mooseframework.org
RichardsSat.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 RichardsSat;
15 
16 template <>
17 InputParameters validParams<RichardsSat>();
18 
24 class RichardsSat : public GeneralUserObject
25 {
26 public:
27  RichardsSat(const InputParameters & parameters);
28 
29  void initialize();
30  void execute();
31  void finalize();
32 
37  Real sat(Real seff) const;
38 
40  Real dsat(Real /*seff*/) const;
41 
42 protected:
44  Real _s_res;
45 
47  Real _sum_s_res;
48 };
49 
validParams< RichardsSat >
InputParameters validParams< RichardsSat >()
Definition: RichardsSat.C:18
RichardsSat::_sum_s_res
Real _sum_s_res
sum of the residual saturations for every phase
Definition: RichardsSat.h:47
RichardsSat::dsat
Real dsat(Real) const
derivative of saturation wrt effective saturation
Definition: RichardsSat.C:65
RichardsSat::execute
void execute()
Definition: RichardsSat.C:50
RichardsSat
Saturation of a phase as a function of effective saturation of that phase, and its derivatives wrt ef...
Definition: RichardsSat.h:24
RichardsSat::_s_res
Real _s_res
residual saturation for this phase
Definition: RichardsSat.h:44
RichardsSat::initialize
void initialize()
Definition: RichardsSat.C:45
RichardsSat::sat
Real sat(Real seff) const
saturation as a function of effective saturation
Definition: RichardsSat.C:60
RichardsSat::finalize
void finalize()
Definition: RichardsSat.C:55
RichardsSat::RichardsSat
RichardsSat(const InputParameters &parameters)
Definition: RichardsSat.C:35