Base class Material designed to provide the porosity. More...

#include <PorousFlowPorosityExponentialBase.h>

Inheritance diagram for PorousFlowPorosityExponentialBase:

Public Member Functions
	PorousFlowPorosityExponentialBase (const InputParameters &parameters)

Protected Member Functions
virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

virtual Real	atNegInfinityQp () const =0
	Returns "a" at the quadpoint (porosity = a + (b - a) * exp(decay)) More...

virtual Real	datNegInfinityQp (unsigned pvar) const =0
	d(a)/d(PorousFlow variable pvar) More...

virtual Real	atZeroQp () const =0
	Returns "b" at the quadpoint (porosity = a + (b - a) * exp(decay)) More...

virtual Real	datZeroQp (unsigned pvar) const =0
	d(a)/d(PorousFlow variable pvar) More...

virtual Real	decayQp () const =0
	Returns "decay" at the quadpoint (porosity = a + (b - a) * exp(decay)) More...

virtual Real	ddecayQp_dvar (unsigned pvar) const =0
	d(decay)/d(PorousFlow variable pvar) More...

virtual RealGradient	ddecayQp_dgradvar (unsigned pvar) const =0
	d(decay)/d(grad(PorousFlow variable pvar)) More...

Protected Attributes
const bool	_strain_at_nearest_qp
	When calculating nodal porosity, use the strain at the nearest quadpoint to the node. More...

const bool	_ensure_positive
	for decayQp() > 0, porosity can be negative when using porosity = a + (b - a) * exp(decay). More...

MaterialProperty< Real > &	_porosity
	Computed porosity at the nodes or quadpoints. More...

MaterialProperty< std::vector< Real > > &	_dporosity_dvar
	d(porosity)/d(PorousFlow variable) More...

MaterialProperty< std::vector< RealGradient > > &	_dporosity_dgradvar
	d(porosity)/d(grad PorousFlow variable) More...

const unsigned int	_num_phases
	Number of phases. More...

const unsigned int	_num_components
	Number of fluid components. More...

const unsigned int	_num_var
	Number of PorousFlow variables. More...

Detailed Description

Base class Material designed to provide the porosity.

In this class porosity = a + (b - a) * exp(decay) where a = atNegInfinityQp() b = atZeroQp() decay = decayQp() Since this expression can become negative for decay > 0, if ensure_positive = true then for decay > 0 the following expression is used instead: porosity = a + (b - a) * exp(c * (1 - Exp(- decay / c))) where c = log(a/(b-a)) This latter expression is C1 continuous at decay=0 with the former expression. It is monotonically decreasing with "decay" and is positive.

Definition at line 36 of file PorousFlowPorosityExponentialBase.h.

Constructor & Destructor Documentation

◆ PorousFlowPorosityExponentialBase()

PorousFlowPorosityExponentialBase::PorousFlowPorosityExponentialBase ( const InputParameters & parameters )

Definition at line 35 of file PorousFlowPorosityExponentialBase.C.

   : PorousFlowPorosityBase(parameters),
     _strain_at_nearest_qp(getParam<bool>("strain_at_nearest_qp")),
     _ensure_positive(getParam<bool>("ensure_positive"))
 {
 }

Member Function Documentation

◆ atNegInfinityQp()

virtual Real PorousFlowPorosityExponentialBase::atNegInfinityQp ( ) const

protectedpure virtual

Returns "a" at the quadpoint (porosity = a + (b - a) * exp(decay))

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ atZeroQp()

virtual Real PorousFlowPorosityExponentialBase::atZeroQp ( ) const

protectedpure virtual

Returns "b" at the quadpoint (porosity = a + (b - a) * exp(decay))

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ computeQpProperties()

void PorousFlowPorosityExponentialBase::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowPorosityHMBiotModulus.

Definition at line 62 of file PorousFlowPorosityExponentialBase.C.

 {
   const Real a = atNegInfinityQp();
   const Real b = atZeroQp();
   const Real decay = decayQp();
   Real exp_term = 1.0; // set appropriately below
  
   Real deriv = 0.0; // = d(porosity)/d(decay)
   if (decay <= 0.0 || !_ensure_positive)
   {
     exp_term = std::exp(decay);
     _porosity[_qp] = a + (b - a) * exp_term;
     deriv = _porosity[_qp] - a;
   }
   else
   {
     const Real c = std::log(a / (a - b));
     const Real expx = std::exp(-decay / c);
     // note that at decay = 0, we have expx = 1, so porosity = a + b - a = b
     // and at decay = infinity, expx = 0, so porosity = a + (b - a) * a / (a - b) = 0
     exp_term = std::exp(c * (1.0 - expx));
     _porosity[_qp] = a + (b - a) * exp_term;
     deriv = (_porosity[_qp] - a) * expx;
   }
  
   _dporosity_dvar[_qp].resize(_num_var);
   _dporosity_dgradvar[_qp].resize(_num_var);
   for (unsigned int v = 0; v < _num_var; ++v)
   {
     _dporosity_dvar[_qp][v] = ddecayQp_dvar(v) * deriv;
     _dporosity_dgradvar[_qp][v] = ddecayQp_dgradvar(v) * deriv;
  
     const Real da = datNegInfinityQp(v);
     const Real db = datZeroQp(v);
     _dporosity_dvar[_qp][v] += da * (1 - exp_term) + db * exp_term;
  
     if (!(decay <= 0.0 || !_ensure_positive))
     {
       const Real c = std::log(a / (a - b));
       const Real expx = std::exp(-decay / c);
       const Real dc = (a - b) * (da * b / a - db) / std::pow(a, 2);
       _dporosity_dvar[_qp][v] += (b - a) * exp_term * dc * (1 - expx - expx / c);
     }
   }
 }

◆ datNegInfinityQp()

virtual Real PorousFlowPorosityExponentialBase::datNegInfinityQp ( unsigned pvar ) const

protectedpure virtual

d(a)/d(PorousFlow variable pvar)

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties().

◆ datZeroQp()

virtual Real PorousFlowPorosityExponentialBase::datZeroQp ( unsigned pvar ) const

protectedpure virtual

d(a)/d(PorousFlow variable pvar)

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties().

◆ ddecayQp_dgradvar()

virtual RealGradient PorousFlowPorosityExponentialBase::ddecayQp_dgradvar ( unsigned pvar ) const

protectedpure virtual

d(decay)/d(grad(PorousFlow variable pvar))

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties().

◆ ddecayQp_dvar()

virtual Real PorousFlowPorosityExponentialBase::ddecayQp_dvar ( unsigned pvar ) const

protectedpure virtual

d(decay)/d(PorousFlow variable pvar)

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties().

◆ decayQp()

virtual Real PorousFlowPorosityExponentialBase::decayQp ( ) const

protectedpure virtual

Returns "decay" at the quadpoint (porosity = a + (b - a) * exp(decay))

Implemented in PorousFlowPorosity.

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ initQpStatefulProperties()

void PorousFlowPorosityExponentialBase::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 44 of file PorousFlowPorosityExponentialBase.C.

 {
   const Real a = atNegInfinityQp();
   const Real b = atZeroQp();
   mooseAssert(a > b, "PorousFlowPorosityExponentialBase a must be larger than b");
   const Real decay = decayQp();
  
   if (decay <= 0.0 || !_ensure_positive)
     _porosity[_qp] = a + (b - a) * std::exp(decay);
   else
   {
     const Real c = std::log(a / (a - b));
     const Real expx = std::exp(-decay / c);
     _porosity[_qp] = a + (b - a) * std::exp(c * (1.0 - expx));
   }
 }