PorousFlowRelativePermeabilityBase Class Reference

Base class for PorousFlow relative permeability materials. More...

#include <PorousFlowRelativePermeabilityBase.h>

Inheritance diagram for PorousFlowRelativePermeabilityBase:

Public Member Functions
	PorousFlowRelativePermeabilityBase (const InputParameters &parameters)

Protected Member Functions
virtual void	computeQpProperties () override
virtual Real	effectiveSaturation (Real saturation) const
	Effective saturation of fluid phase. More...
virtual Real	relativePermeability (Real seff) const =0
	Relative permeability equation (must be overriden in derived class) More...
virtual Real	dRelativePermeability (Real seff) const =0
	Derivative of relative permeability with respect to effective saturation. More...

Protected Attributes
const Real	_scaling
	Relative permeability is multiplied by this quantity. More...
const MaterialProperty< std::vector< Real > > &	_saturation
	Saturation material property. More...
MaterialProperty< Real > &	_relative_permeability
	Relative permeability material property. More...
MaterialProperty< Real > &	_drelative_permeability_ds
	Derivative of relative permeability wrt phase saturation. More...
const Real	_s_res
	Residual saturation of specified phase. More...
const Real	_sum_s_res
	Sum of residual saturations over all phases. More...
const Real	_dseff_ds
	Derivative of effective saturation with respect to saturation. More...
const unsigned int	_phase_num
	Phase number of fluid. More...
const std::string	_phase
	Stringified fluid phase number. More...

Detailed Description

Base class for PorousFlow relative permeability materials.

All materials that derive from this class must override relativePermeability() and dRelativePermeability()

Definition at line 24 of file PorousFlowRelativePermeabilityBase.h.

Constructor & Destructor Documentation

PorousFlowRelativePermeabilityBase()

PorousFlowRelativePermeabilityBase::PorousFlowRelativePermeabilityBase

(

const InputParameters &

parameters

)

Definition at line 34 of file PorousFlowRelativePermeabilityBase.C.

  : PorousFlowMaterialBase(parameters),
    _scaling(getParam<Real>("scaling")),
    _saturation(_nodal_material
                    ? getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_nodal")
                    : getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_qp")),
    _relative_permeability(
        _nodal_material ? declareProperty<Real>("PorousFlow_relative_permeability_nodal" + _phase)
                        : declareProperty<Real>("PorousFlow_relative_permeability_qp" + _phase)),
    _drelative_permeability_ds(
        _nodal_material
            ? declarePropertyDerivative<Real>("PorousFlow_relative_permeability_nodal" + _phase,
                                              _saturation_variable_name)
            : declarePropertyDerivative<Real>("PorousFlow_relative_permeability_qp" + _phase,
                                              _saturation_variable_name)),
    _s_res(getParam<Real>("s_res")),
    _sum_s_res(getParam<Real>("sum_s_res")),
    _dseff_ds(1.0 / (1.0 - _sum_s_res))
{
  if (_sum_s_res < _s_res)
    mooseError("Sum of residual saturations sum_s_res cannot be smaller than s_res in ", name());
}

Member Function Documentation

computeQpProperties()

void PorousFlowRelativePermeabilityBase::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 59 of file PorousFlowRelativePermeabilityBase.C.

{
  // Effective saturation
  Real seff = effectiveSaturation(_saturation[_qp][_phase_num]);
  Real relperm, drelperm;
 
  if (seff < 0.0)
  {
    // Relative permeability is 0 for saturation less than residual
    relperm = 0.0;
    drelperm = 0.0;
  }
  else if (seff >= 0.0 && seff <= 1)
  {
    relperm = relativePermeability(seff);
    drelperm = dRelativePermeability(seff);
  }
  else // seff > 1
  {
    // Relative permeability is 1 when fully saturated
    relperm = 1.0;
    drelperm = 0.0;
  }
 
  _relative_permeability[_qp] = relperm * _scaling;
  _drelative_permeability_ds[_qp] = drelperm * _dseff_ds * _scaling;
}

dRelativePermeability()

virtual Real PorousFlowRelativePermeabilityBase::dRelativePermeability ( Real  seff ) const

protectedpure virtual

Derivative of relative permeability with respect to effective saturation.

Parameters

seff	effective saturation

Returns

derivative of relative permeability wrt effective saturation

Implemented in PorousFlowRelativePermeabilityVG, PorousFlowRelativePermeabilityBC, PorousFlowRelativePermeabilityBW, PorousFlowRelativePermeabilityCorey, PorousFlowRelativePermeabilityFLAC, and PorousFlowRelativePermeabilityConst.

Referenced by computeQpProperties().

effectiveSaturation()

Real PorousFlowRelativePermeabilityBase::effectiveSaturation ( Real  saturation ) const

protectedvirtual

Effective saturation of fluid phase.

Parameters

saturation

true saturation

Returns

effective saturation

Definition at line 88 of file PorousFlowRelativePermeabilityBase.C.

{
  return (saturation - _s_res) / (1.0 - _sum_s_res);
}

Referenced by computeQpProperties().

relativePermeability()

virtual Real PorousFlowRelativePermeabilityBase::relativePermeability ( Real  seff ) const

protectedpure virtual

Relative permeability equation (must be overriden in derived class)

Parameters

seff	effective saturation

Returns

relative permeability

Implemented in PorousFlowRelativePermeabilityVG, PorousFlowRelativePermeabilityBC, PorousFlowRelativePermeabilityBW, PorousFlowRelativePermeabilityCorey, PorousFlowRelativePermeabilityFLAC, and PorousFlowRelativePermeabilityConst.

Referenced by computeQpProperties().

Member Data Documentation

_drelative_permeability_ds

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_drelative_permeability_ds

protected

Derivative of relative permeability wrt phase saturation.

Definition at line 63 of file PorousFlowRelativePermeabilityBase.h.

Referenced by computeQpProperties().

_dseff_ds

const Real PorousFlowRelativePermeabilityBase::_dseff_ds

protected

Derivative of effective saturation with respect to saturation.

Definition at line 72 of file PorousFlowRelativePermeabilityBase.h.

Referenced by computeQpProperties().

_phase

const std::string PorousFlowMaterialBase::_phase

protectedinherited

Stringified fluid phase number.

Definition at line 37 of file PorousFlowMaterialBase.h.

_phase_num

const unsigned int PorousFlowMaterialBase::_phase_num

protectedinherited

Phase number of fluid.

Definition at line 34 of file PorousFlowMaterialBase.h.

Referenced by computeQpProperties(), PorousFlowBrine::computeQpProperties(), PorousFlowSingleComponentFluid::computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), PorousFlowSingleComponentFluid::initQpStatefulProperties(), and PorousFlowMaterialBase::PorousFlowMaterialBase().

_relative_permeability

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_relative_permeability

protected

Relative permeability material property.

Definition at line 60 of file PorousFlowRelativePermeabilityBase.h.

Referenced by computeQpProperties().

_s_res

const Real PorousFlowRelativePermeabilityBase::_s_res

protected

Residual saturation of specified phase.

Definition at line 66 of file PorousFlowRelativePermeabilityBase.h.

Referenced by effectiveSaturation(), and PorousFlowRelativePermeabilityBase().

_saturation

const MaterialProperty<std::vector<Real> >& PorousFlowRelativePermeabilityBase::_saturation

protected

Saturation material property.

Definition at line 57 of file PorousFlowRelativePermeabilityBase.h.

Referenced by computeQpProperties().

_scaling

const Real PorousFlowRelativePermeabilityBase::_scaling

protected

Relative permeability is multiplied by this quantity.

Definition at line 54 of file PorousFlowRelativePermeabilityBase.h.

Referenced by computeQpProperties().

_sum_s_res

const Real PorousFlowRelativePermeabilityBase::_sum_s_res

protected

Sum of residual saturations over all phases.

Definition at line 69 of file PorousFlowRelativePermeabilityBase.h.

Referenced by effectiveSaturation(), and PorousFlowRelativePermeabilityBase().

---

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

• porous_flow/include/materials/PorousFlowRelativePermeabilityBase.h
• porous_flow/src/materials/PorousFlowRelativePermeabilityBase.C