PorousFlowRelativePermeabilityBase.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "PorousFlowMaterialBase.h"

template <bool is_ad>
class PorousFlowRelativePermeabilityBaseTempl : public PorousFlowMaterialBase
{
public:
  static InputParameters validParams();

  PorousFlowRelativePermeabilityBaseTempl(const InputParameters & parameters);

protected:
  virtual void computeQpProperties() override;

  virtual GenericReal<is_ad> effectiveSaturation(GenericReal<is_ad> saturation) const;

  virtual GenericReal<is_ad> relativePermeability(GenericReal<is_ad> seff) const = 0;

  virtual Real dRelativePermeability(Real seff) const = 0;

  const Real _scaling;

  const GenericMaterialProperty<std::vector<Real>, is_ad> & _saturation;

  GenericMaterialProperty<Real, is_ad> & _relative_permeability;

  MaterialProperty<Real> * const _drelative_permeability_ds;

  const Real _s_res;

  const Real _sum_s_res;

  const Real _dseff_ds;
};

typedef PorousFlowRelativePermeabilityBaseTempl<false> PorousFlowRelativePermeabilityBase;
typedef PorousFlowRelativePermeabilityBaseTempl<true> ADPorousFlowRelativePermeabilityBase;