PorousFlowRelativePermeabilityConst Class Reference

This class simply sets a constant relative permeability at the nodes. More...

#include <PorousFlowRelativePermeabilityConst.h>

Inheritance diagram for PorousFlowRelativePermeabilityConst:

Public Member Functions
	PorousFlowRelativePermeabilityConst (const InputParameters &parameters)

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

Protected Attributes
const Real	_relperm
	Constant relative permeability. More...
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

This class simply sets a constant relative permeability at the nodes.

This simple class is useful for testing purposes mainly

Definition at line 23 of file PorousFlowRelativePermeabilityConst.h.

Constructor & Destructor Documentation

PorousFlowRelativePermeabilityConst()

PorousFlowRelativePermeabilityConst::PorousFlowRelativePermeabilityConst

(

const InputParameters &

parameters

)

Definition at line 25 of file PorousFlowRelativePermeabilityConst.C.

  : PorousFlowRelativePermeabilityBase(parameters), _relperm(getParam<Real>("kr"))
{
}

Member Function Documentation

computeQpProperties()

void PorousFlowRelativePermeabilityBase::computeQpProperties ( )

overrideprotectedvirtualinherited

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()

Real PorousFlowRelativePermeabilityConst::dRelativePermeability ( Real  seff ) const

overrideprotectedvirtual

Derivative of relative permeability with respect to effective saturation.

Parameters

seff	effective saturation

Returns

derivative of relative permeability wrt effective saturation

Implements PorousFlowRelativePermeabilityBase.

Definition at line 36 of file PorousFlowRelativePermeabilityConst.C.

{ return 0.0; }

effectiveSaturation()

Real PorousFlowRelativePermeabilityBase::effectiveSaturation ( Real  saturation ) const

protectedvirtualinherited

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 PorousFlowRelativePermeabilityBase::computeQpProperties().

relativePermeability()

Real PorousFlowRelativePermeabilityConst::relativePermeability ( Real  seff ) const

overrideprotectedvirtual

Relative permeability equation (must be overriden in derived class)

Parameters

seff	effective saturation

Returns

relative permeability

Implements PorousFlowRelativePermeabilityBase.

Definition at line 31 of file PorousFlowRelativePermeabilityConst.C.

{
  return _relperm;
}

Member Data Documentation

_drelative_permeability_ds

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_drelative_permeability_ds

protectedinherited

Derivative of relative permeability wrt phase saturation.

Definition at line 63 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

_dseff_ds

const Real PorousFlowRelativePermeabilityBase::_dseff_ds

protectedinherited

Derivative of effective saturation with respect to saturation.

Definition at line 72 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::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 PorousFlowRelativePermeabilityBase::computeQpProperties(), PorousFlowBrine::computeQpProperties(), PorousFlowSingleComponentFluid::computeQpProperties(), PorousFlowBrine::initQpStatefulProperties(), PorousFlowSingleComponentFluid::initQpStatefulProperties(), and PorousFlowMaterialBase::PorousFlowMaterialBase().

_relative_permeability

MaterialProperty<Real>& PorousFlowRelativePermeabilityBase::_relative_permeability

protectedinherited

Relative permeability material property.

Definition at line 60 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

_relperm

const Real PorousFlowRelativePermeabilityConst::_relperm

protected

Constant relative permeability.

Definition at line 33 of file PorousFlowRelativePermeabilityConst.h.

Referenced by relativePermeability().

_s_res

const Real PorousFlowRelativePermeabilityBase::_s_res

protectedinherited

Residual saturation of specified phase.

Definition at line 66 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::effectiveSaturation(), and PorousFlowRelativePermeabilityBase::PorousFlowRelativePermeabilityBase().

_saturation

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

protectedinherited

Saturation material property.

Definition at line 57 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

_scaling

const Real PorousFlowRelativePermeabilityBase::_scaling

protectedinherited

Relative permeability is multiplied by this quantity.

Definition at line 54 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::computeQpProperties().

_sum_s_res

const Real PorousFlowRelativePermeabilityBase::_sum_s_res

protectedinherited

Sum of residual saturations over all phases.

Definition at line 69 of file PorousFlowRelativePermeabilityBase.h.

Referenced by PorousFlowRelativePermeabilityBase::effectiveSaturation(), and PorousFlowRelativePermeabilityBase::PorousFlowRelativePermeabilityBase().

---

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

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