Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       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             : //  This post processor returns the saturation of a region.
      11             : //
      12             : #include "RichardsSatAux.h"
      13             : 
      14             : registerMooseObject("RichardsApp", RichardsSatAux);
      15             : 
      16             : InputParameters
      17           9 : RichardsSatAux::validParams()
      18             : {
      19           9 :   InputParameters params = AuxKernel::validParams();
      20          18 :   params.addRequiredCoupledVar("seff_var", "Variable that is the effective saturation");
      21          18 :   params.addRequiredParam<UserObjectName>("sat_UO", "Name of user object that defines saturation.");
      22           9 :   params.addClassDescription("auxillary variable which is saturation");
      23           9 :   return params;
      24           0 : }
      25             : 
      26           2 : RichardsSatAux::RichardsSatAux(const InputParameters & parameters)
      27             :   : AuxKernel(parameters),
      28           2 :     _seff_var(coupledValue("seff_var")),
      29           4 :     _sat_UO(getUserObject<RichardsSat>("sat_UO"))
      30             : {
      31           2 : }
      32             : 
      33             : Real
      34         606 : RichardsSatAux::computeValue()
      35             : {
      36         606 :   return _sat_UO.sat(_seff_var[_qp]);
      37             : }