PorousFlowCapillaryPressure.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "DiscreteElementUserObject.h"

class PorousFlowCapillaryPressure : public DiscreteElementUserObject
{
public:
  static InputParameters validParams();

  PorousFlowCapillaryPressure(const InputParameters & parameters);

  virtual void initialize() final{};
  virtual void initialSetup() override;

  virtual Real capillaryPressure(Real saturation, unsigned qp = 0) const;
  virtual ADReal capillaryPressure(const ADReal & saturation, unsigned qp = 0) const;

  virtual Real dCapillaryPressure(Real saturation, unsigned qp = 0) const;
  virtual ADReal dCapillaryPressure(const ADReal & saturation, unsigned qp = 0) const;

  virtual Real d2CapillaryPressure(Real saturation, unsigned qp = 0) const;

  virtual Real effectiveSaturation(Real pc, unsigned qp = 0) const = 0;

  virtual Real dEffectiveSaturation(Real pc, unsigned qp = 0) const = 0;

  virtual Real d2EffectiveSaturation(Real pc, unsigned qp = 0) const = 0;

  Real saturation(Real pc, unsigned qp = 0) const;
  ADReal saturation(const ADReal & pc, unsigned qp = 0) const;

  Real dSaturation(Real pc, unsigned qp = 0) const;
  ADReal dSaturation(const ADReal & pc, unsigned int qp = 0) const;

  Real d2Saturation(Real pc, unsigned qp = 0) const;

protected:
  Real effectiveSaturationFromSaturation(Real saturation) const;

  Real extensionSaturation() const;

  Real interceptFunction(Real s) const;

  Real interceptFunctionDeriv(Real s) const;

  Real capillaryPressureLogExt(Real s) const;

  Real dCapillaryPressureLogExt(Real s) const;

  Real d2CapillaryPressureLogExt(Real s) const;

  virtual Real capillaryPressureCurve(Real saturation, unsigned qp = 0) const = 0;

  virtual Real dCapillaryPressureCurve(Real saturation, unsigned qp = 0) const = 0;

  virtual Real d2CapillaryPressureCurve(Real saturation, unsigned qp = 0) const = 0;

  const Real _sat_lr;
  const Real _dseff_ds;
  bool _log_ext;
  const Real _pc_max;

  Real _sat_ext;
  Real _pc_ext;
  Real _slope_ext;
  const Real _log10;
};