Material designed to calculate fluid-phase porepressure and saturation for the single-phase situation, assuming a Gaussian capillary suction function and assuming the independent variable is log(mass density) and assuming the fluid has a constant bulk modulus. More...

#include <PorousFlow1PhaseMD_Gaussian.h>

Inheritance diagram for PorousFlow1PhaseMD_Gaussian:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlow1PhaseMD_Gaussian (const InputParameters &parameters)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialProperty (const std::string &name)

const GenericMaterialProperty< U, is_ad > &	getDefaultMaterialPropertyByName (const std::string &name)

void	validateDerivativeMaterialPropertyBase (const std::string &base)

const MaterialPropertyName	derivativePropertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	derivativePropertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	derivativePropertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	derivativePropertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

GenericMaterialProperty< U, is_ad > &	declarePropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, const SymbolName &c1, unsigned int v2, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivative (const std::string &base, unsigned int v1, unsigned int v2=libMesh::invalid_uint, unsigned int v3=libMesh::invalid_uint)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< VariableName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const std::vector< SymbolName > &c)

const GenericMaterialProperty< U, is_ad > &	getMaterialPropertyDerivativeByName (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2="", const SymbolName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateCoupling (const MaterialPropertyName &base, const std::vector< VariableName > &c, bool validate_aux=true)

void	validateCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

void	validateNonlinearCoupling (const MaterialPropertyName &base, const VariableName &c1="", const VariableName &c2="", const VariableName &c3="")

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyName (const MaterialPropertyName &base, const std::vector< SymbolName > &c) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameFirst (const MaterialPropertyName &base, const SymbolName &c1) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameSecond (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

const MaterialPropertyName	propertyNameThird (const MaterialPropertyName &base, const SymbolName &c1, const SymbolName &c2, const SymbolName &c3) const

Static Public Member Functions
static InputParameters	validParams ()

Protected Member Functions
virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

virtual void	buildPS ()

Protected Attributes
const Real	_al
	Gaussian parameter: saturation = exp(-(al*p)^2) More...

const Real	_al2
	_al2 = al*al More...

const Real	_logdens0
	Fluid density = _dens0*exp(P/_bulk) More...

const Real	_bulk
	Fluid density = _dens0*exp(P/_bulk) More...

const Real	_recip_bulk
	1/_bulk/_al More...

const Real	_recip_bulk2
	(1/_bulk)^2 More...

const VariableValue &	_md_var
	Nodal or quadpoint value of mass-density of the fluid phase. More...

const VariableGradient &	_gradmd_qp_var
	Gradient(_mass-density at quadpoints) More...

const unsigned int	_md_varnum
	Moose variable number of the mass-density. More...

const unsigned int	_pvar
	PorousFlow variable number of the mass-density. More...

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

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

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

GenericMaterialProperty< std::vector< Real >, is_ad > &	_porepressure
	Computed nodal or quadpoint values of porepressure of the phases. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dporepressure_dvar
	d(porepressure)/d(PorousFlow variable) More...

GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const	_gradp_qp
	Grad(p) at the quadpoints. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dgradp_qp_dgradv
	d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints More...

MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgradp_qp_dv
	d(grad porepressure)/d(PorousFlow variable) at the quadpoints More...

GenericMaterialProperty< std::vector< Real >, is_ad > &	_saturation
	Computed nodal or qp saturation of the phases. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dsaturation_dvar
	d(saturation)/d(PorousFlow variable) More...

GenericMaterialProperty< std::vector< RealGradient >, is_ad > *const	_grads_qp
	Grad(s) at the quadpoints. More...

MaterialProperty< std::vector< std::vector< Real > > > *const	_dgrads_qp_dgradv
	d(grad saturation)/d(grad PorousFlow variable) at the quadpoints More...

MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_dgrads_qp_dv
	d(grad saturation)/d(PorousFlow variable) at the quadpoints More...

Detailed Description

Material designed to calculate fluid-phase porepressure and saturation for the single-phase situation, assuming a Gaussian capillary suction function and assuming the independent variable is log(mass density) and assuming the fluid has a constant bulk modulus.

Definition at line 20 of file PorousFlow1PhaseMD_Gaussian.h.

Constructor & Destructor Documentation

◆ PorousFlow1PhaseMD_Gaussian()

PorousFlow1PhaseMD_Gaussian::PorousFlow1PhaseMD_Gaussian ( const InputParameters & parameters )

Definition at line 37 of file PorousFlow1PhaseMD_Gaussian.C.

   : PorousFlowVariableBase(parameters),
 
     _al(getParam<Real>("al")),
     _al2(std::pow(_al, 2)),
     _logdens0(std::log(getParam<Real>("density_P0"))),
     _bulk(getParam<Real>("bulk_modulus")),
     _recip_bulk(1.0 / _al / _bulk),
     _recip_bulk2(std::pow(_recip_bulk, 2)),
 
     _md_var(_nodal_material ? coupledDofValues("mass_density") : coupledValue("mass_density")),
     _gradmd_qp_var(coupledGradient("mass_density")),
     _md_varnum(coupled("mass_density")),
     _pvar(_dictator.isPorousFlowVariable(_md_varnum) ? _dictator.porousFlowVariableNum(_md_varnum)
                                                      : 0)
 {
   if (_num_phases != 1)
     mooseError("The Dictator proclaims that the number of phases is ",
                _dictator.numPhases(),
                " whereas PorousFlow1PhaseMD_Gaussian can only be used for 1-phase simulations.  Be "
                "aware that the Dictator has noted your mistake.");
 }

Member Function Documentation

◆ buildPS()

void PorousFlow1PhaseMD_Gaussian::buildPS ( )

protectedvirtual

Definition at line 139 of file PorousFlow1PhaseMD_Gaussian.C.

Referenced by computeQpProperties(), and initQpStatefulProperties().

 {
   if (_md_var[_qp] >= _logdens0)
   {
     // full saturation
     _porepressure[_qp][0] = (_md_var[_qp] - _logdens0) * _bulk;
     _saturation[_qp][0] = 1.0;
   }
   else
   {
     // v = logdens0 + p/bulk - (al p)^2
     // 0 = (v-logdens0) - p/bulk + (al p)^2
     // 2 al p = (1/al/bulk) +/- sqrt((1/al/bulk)^2 - 4(v-logdens0))  (the "minus" sign is chosen)
     // s = exp(-(al*p)^2)
     _porepressure[_qp][0] =
         (_recip_bulk - std::sqrt(_recip_bulk2 + 4.0 * (_logdens0 - _md_var[_qp]))) / (2.0 * _al);
     _saturation[_qp][0] = std::exp(-std::pow(_al * _porepressure[_qp][0], 2.0));
   }
 }

◆ computeQpProperties()

void PorousFlow1PhaseMD_Gaussian::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowVariableBaseTempl< is_ad >.

Definition at line 68 of file PorousFlow1PhaseMD_Gaussian.C.

 {
   // size stuff correctly and prepare the derivative matrices with zeroes
   PorousFlowVariableBase::computeQpProperties();
 
   buildPS();
 
   if (!_nodal_material)
   {
     if (_md_var[_qp] >= _logdens0)
     {
       (*_gradp_qp)[_qp][0] = _gradmd_qp_var[_qp] * _bulk;
       (*_grads_qp)[_qp][0] = 0.0;
     }
     else
     {
       (*_gradp_qp)[_qp][0] =
           _gradmd_qp_var[_qp] / (_recip_bulk - 2.0 * _al * _porepressure[_qp][0]) / _al;
       (*_grads_qp)[_qp][0] =
           -2.0 * _al2 * _porepressure[_qp][0] * _saturation[_qp][0] * (*_gradp_qp)[_qp][0];
     }
   }
 
   if (_dictator.notPorousFlowVariable(_md_varnum))
     return;
 
   if (_md_var[_qp] >= _logdens0)
   {
     // fully saturated at the node or quadpoint
     (*_dporepressure_dvar)[_qp][0][_pvar] = _bulk;
     (*_dsaturation_dvar)[_qp][0][_pvar] = 0.0;
   }
   else
   {
     const Real pp = _porepressure[_qp][0];
     (*_dporepressure_dvar)[_qp][0][_pvar] = 1.0 / (_recip_bulk - 2.0 * _al * pp) / _al;
     const Real sat = _saturation[_qp][0];
     (*_dsaturation_dvar)[_qp][0][_pvar] =
         -2.0 * _al2 * pp * sat * (*_dporepressure_dvar)[_qp][0][_pvar];
   }
 
   if (!_nodal_material)
   {
     if (_md_var[_qp] >= _logdens0)
     {
       // fully saturated at the quadpoint
       (*_dgradp_qp_dgradv)[_qp][0][_pvar] = _bulk;
       (*_dgradp_qp_dv)[_qp][0][_pvar] = 0.0;
       (*_dgrads_qp_dgradv)[_qp][0][_pvar] = 0.0;
       (*_dgrads_qp_dv)[_qp][0][_pvar] = 0.0;
     }
     else
     {
       const Real pp = _porepressure[_qp][0];
       (*_dgradp_qp_dgradv)[_qp][0][_pvar] = 1.0 / (_recip_bulk - 2.0 * _al * pp) / _al;
       (*_dgradp_qp_dv)[_qp][0][_pvar] = _gradmd_qp_var[_qp] * 2.0 * _al *
                                         (*_dporepressure_dvar)[_qp][0][_pvar] /
                                         std::pow(_recip_bulk - 2.0 * _al * pp, 2.0) / _al;
       const Real sat = _saturation[_qp][0];
       (*_dgrads_qp_dgradv)[_qp][0][_pvar] =
           -2.0 * _al2 * pp * sat * (*_dgradp_qp_dgradv)[_qp][0][_pvar];
       (*_dgrads_qp_dv)[_qp][0][_pvar] =
           -2.0 * _al2 * (*_dporepressure_dvar)[_qp][0][_pvar] * sat * (*_gradp_qp)[_qp][0];
       (*_dgrads_qp_dv)[_qp][0][_pvar] +=
           -2.0 * _al2 * pp * (*_dsaturation_dvar)[_qp][0][_pvar] * (*_gradp_qp)[_qp][0];
       (*_dgrads_qp_dv)[_qp][0][_pvar] += -2.0 * _al2 * pp * sat * (*_dgradp_qp_dv)[_qp][0][_pvar];
     }
   }
 }

◆ initQpStatefulProperties()

void PorousFlow1PhaseMD_Gaussian::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowVariableBaseTempl< is_ad >.

Definition at line 61 of file PorousFlow1PhaseMD_Gaussian.C.

 {
   PorousFlowVariableBase::initQpStatefulProperties();
   buildPS();
 }

◆ validParams()

InputParameters PorousFlow1PhaseMD_Gaussian::validParams ( )

static

Definition at line 15 of file PorousFlow1PhaseMD_Gaussian.C.

 {
   InputParameters params = PorousFlowVariableBase::validParams();
   params.addRequiredCoupledVar("mass_density",
                                "Variable that represents log(mass-density) of the single phase");
   params.addRequiredRangeCheckedParam<Real>(
       "al",
       "al>0",
       "For this class, the capillary function is assumed to be saturation = "
       "exp(-(al*porepressure)^2) for porepressure<0.");
   params.addRequiredRangeCheckedParam<Real>(
       "density_P0", "density_P0>0", "The density of the fluid phase at zero porepressure");
   params.addRequiredRangeCheckedParam<Real>(
       "bulk_modulus", "bulk_modulus>0", "The constant bulk modulus of the fluid phase");
   params.addClassDescription("This Material is used for the single-phase situation where "
                              "log(mass-density) is the primary variable.  calculates the 1 "
                              "porepressure and the 1 saturation in a 1-phase situation, "
                              "and derivatives of these with respect to the PorousFlowVariables.  A "
                              "gaussian capillary function is assumed");
   return params;
 }