Material designed to calculate fluid phase porepressure and saturation for the single-phase situation assuming constant effective saturation and porepressure as the nonlinear variable. More...

#include <PorousFlow1PhaseP.h>

Inheritance diagram for PorousFlow1PhasePTempl< is_ad >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlow1PhasePTempl (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

void	buildQpPPSS ()
	Assemble std::vectors of porepressure, saturation and temperature at the quadpoints.

Protected Attributes
const GenericVariableValue< is_ad > &	_porepressure_var
	Nodal or quadpoint value of porepressure of the fluid phase.

const GenericVariableGradient< is_ad > &	_gradp_qp_var
	Gradient(_porepressure at quadpoints)

const unsigned int	_porepressure_varnum
	Moose variable number of the porepressure.

const unsigned int	_p_var_num
	The PorousFlow variable number of the porepressure.

const PorousFlowCapillaryPressure &	_pc_uo
	Capillary pressure UserObject.

	usingPorousFlowVariableBaseMembers

const unsigned int	_num_phases
	Number of phases.

const unsigned int	_num_components
	Number of components.

const unsigned int	_num_pf_vars
	Number of PorousFlow variables.

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

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

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

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

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

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

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

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

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

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

Private Member Functions
bool	haveMaterialProperty (const std::string &prop_name)

std::vector< VariableName >	buildVariableVector (const VariableName &c1, const VariableName &c2, const VariableName &c3)

void	validateCouplingHelper (const MaterialPropertyName &base, const std::vector< VariableName > &c, const System &system, std::vector< VariableName > &missing)

bool	isNotObjectVariable (const VariableName &name)

Private Attributes
FEProblemBase &	_dmi_fe_problem

Detailed Description

template<bool is_ad>
class PorousFlow1PhasePTempl< is_ad >

Material designed to calculate fluid phase porepressure and saturation for the single-phase situation assuming constant effective saturation and porepressure as the nonlinear variable.

Definition at line 22 of file PorousFlow1PhaseP.h.

Constructor & Destructor Documentation

◆ PorousFlow1PhasePTempl()

template<bool is_ad>

PorousFlow1PhasePTempl< is_ad >::PorousFlow1PhasePTempl ( const InputParameters & parameters )

Definition at line 31 of file PorousFlow1PhaseP.C.

  : PorousFlowVariableBaseTempl<is_ad>(parameters),
    _porepressure_var(_nodal_material ? this->template coupledGenericDofValue<is_ad>("porepressure")
                                      : this->template coupledGenericValue<is_ad>("porepressure")),
    _gradp_qp_var(this->template coupledGenericGradient<is_ad>("porepressure")),
    _porepressure_varnum(coupled("porepressure")),
    _p_var_num(_dictator.isPorousFlowVariable(_porepressure_varnum)
                   ? _dictator.porousFlowVariableNum(_porepressure_varnum)
                   : 0),
    _pc_uo(this->template getUserObject<PorousFlowCapillaryPressure>("capillary_pressure"))
{
  if (_num_phases != 1)
    mooseError("The Dictator proclaims that the number of phases is ",
               _dictator.numPhases(),
               " whereas PorousFlow1PhaseP can only be used for 1-phase simulations.  Be aware "
               "that the Dictator has noted your mistake.");
}

Member Function Documentation

◆ buildQpPPSS()

template<bool is_ad>

void PorousFlow1PhasePTempl< is_ad >::buildQpPPSS ( )

protected

Assemble std::vectors of porepressure, saturation and temperature at the quadpoints.

Definition at line 94 of file PorousFlow1PhaseP.C.

{
  _porepressure[_qp][0] = _porepressure_var[_qp];
  _saturation[_qp][0] = _pc_uo.saturation(_porepressure_var[_qp]);
}

◆ computeQpProperties()

template<bool is_ad>

void PorousFlow1PhasePTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowVariableBaseTempl< is_ad >.

Definition at line 59 of file PorousFlow1PhaseP.C.

{
  // size stuff correctly and prepare the derivative matrices with zeroes
  PorousFlowVariableBaseTempl<is_ad>::computeQpProperties();
 
  buildQpPPSS();
 
  const auto ds = _pc_uo.dSaturation(_porepressure_var[_qp]);
 
  if (!_nodal_material)
  {
    (*_gradp_qp)[_qp][0] = _gradp_qp_var[_qp];
    (*_grads_qp)[_qp][0] = ds * _gradp_qp_var[_qp];
  }
 
  // _porepressure is only dependent on _porepressure, and its derivative is 1
  if constexpr (!is_ad)
    if (_dictator.isPorousFlowVariable(_porepressure_varnum))
    {
      // _porepressure is a PorousFlow variable
      (*_dporepressure_dvar)[_qp][0][_p_var_num] = 1.0;
      (*_dsaturation_dvar)[_qp][0][_p_var_num] = ds;
 
      if (!_nodal_material)
      {
        (*_dgradp_qp_dgradv)[_qp][0][_p_var_num] = 1.0;
        (*_dgrads_qp_dgradv)[_qp][0][_p_var_num] = ds;
        (*_dgrads_qp_dv)[_qp][0][_p_var_num] =
            _pc_uo.d2Saturation(_porepressure_var[_qp]) * _gradp_qp_var[_qp];
      }
    }
}

◆ initQpStatefulProperties()

template<bool is_ad>

void PorousFlow1PhasePTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowVariableBaseTempl< is_ad >.

Definition at line 51 of file PorousFlow1PhaseP.C.

{
  PorousFlowVariableBaseTempl<is_ad>::initQpStatefulProperties();
  buildQpPPSS();
}

◆ validParams()

template<bool is_ad>

InputParameters PorousFlow1PhasePTempl< is_ad >::validParams ( )

static

Definition at line 18 of file PorousFlow1PhaseP.C.

{
  InputParameters params = PorousFlowVariableBase::validParams();
  params.addRequiredCoupledVar("porepressure",
                               "Variable that represents the porepressure of the single phase");
  params.addRequiredParam<UserObjectName>("capillary_pressure",
                                          "Name of the UserObject defining the capillary pressure");
  params.addClassDescription("This Material is used for the partially saturated single-phase "
                             "situation where porepressure is the primary variable");
  return params;
}

Member Data Documentation

◆ _dgradp_qp_dgradv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dgradv

protectedinherited

d(grad porepressure)/d(grad PorousFlow variable) at the quadpoints

Definition at line 51 of file PorousFlowVariableBase.h.

◆ _dgradp_qp_dv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgradp_qp_dv

protectedinherited

d(grad porepressure)/d(PorousFlow variable) at the quadpoints

Definition at line 54 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dgradv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dgradv

protectedinherited

d(grad saturation)/d(grad PorousFlow variable) at the quadpoints

Definition at line 66 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dv

template<bool is_ad>

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBaseTempl< is_ad >::_dgrads_qp_dv

protectedinherited

d(grad saturation)/d(PorousFlow variable) at the quadpoints

Definition at line 69 of file PorousFlowVariableBase.h.

◆ _dporepressure_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dporepressure_dvar

protectedinherited

d(porepressure)/d(PorousFlow variable)

Definition at line 45 of file PorousFlowVariableBase.h.

◆ _dsaturation_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBaseTempl< is_ad >::_dsaturation_dvar

protectedinherited

d(saturation)/d(PorousFlow variable)

Definition at line 60 of file PorousFlowVariableBase.h.

◆ _gradp_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_gradp_qp

protectedinherited

Grad(p) at the quadpoints.

Definition at line 48 of file PorousFlowVariableBase.h.

◆ _gradp_qp_var

template<bool is_ad>

const GenericVariableGradient<is_ad>& PorousFlow1PhasePTempl< is_ad >::_gradp_qp_var

protected

Gradient(_porepressure at quadpoints)

Definition at line 41 of file PorousFlow1PhaseP.h.

◆ _grads_qp

template<bool is_ad>

GenericMaterialProperty<std::vector<RealGradient>, is_ad>* const PorousFlowVariableBaseTempl< is_ad >::_grads_qp

protectedinherited

Grad(s) at the quadpoints.

Definition at line 63 of file PorousFlowVariableBase.h.

◆ _num_components

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_components

protectedinherited

Number of components.

Definition at line 36 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl().

◆ _num_pf_vars

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_pf_vars

protectedinherited

Number of PorousFlow variables.

Definition at line 39 of file PorousFlowVariableBase.h.

◆ _num_phases

template<bool is_ad>

const unsigned int PorousFlowVariableBaseTempl< is_ad >::_num_phases

protectedinherited

Number of phases.

Definition at line 33 of file PorousFlowVariableBase.h.

Referenced by PorousFlow2PhaseHysPS::computeQpProperties(), PorousFlow1PhaseFullySaturatedTempl< is_ad >::PorousFlow1PhaseFullySaturatedTempl(), PorousFlow1PhaseHysP::PorousFlow1PhaseHysP(), PorousFlow1PhaseMD_Gaussian::PorousFlow1PhaseMD_Gaussian(), PorousFlow1PhasePTempl< is_ad >::PorousFlow1PhasePTempl(), PorousFlow2PhaseHysPP::PorousFlow2PhaseHysPP(), PorousFlow2PhaseHysPS::PorousFlow2PhaseHysPS(), PorousFlow2PhasePPTempl< is_ad >::PorousFlow2PhasePPTempl(), PorousFlowFluidStateBaseMaterialTempl< is_ad >::PorousFlowFluidStateBaseMaterialTempl(), PorousFlowFluidStateSingleComponentTempl< is_ad >::PorousFlowFluidStateSingleComponentTempl(), and PorousFlowFluidStateTempl< is_ad >::PorousFlowFluidStateTempl().

◆ _p_var_num

template<bool is_ad>

const unsigned int PorousFlow1PhasePTempl< is_ad >::_p_var_num

protected

The PorousFlow variable number of the porepressure.

Definition at line 45 of file PorousFlow1PhaseP.h.

◆ _pc_uo

template<bool is_ad>

const PorousFlowCapillaryPressure& PorousFlow1PhasePTempl< is_ad >::_pc_uo

protected

Capillary pressure UserObject.

Definition at line 47 of file PorousFlow1PhaseP.h.

◆ _porepressure

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_porepressure

protectedinherited

Computed nodal or quadpoint values of porepressure of the phases.

Definition at line 42 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), PorousFlow2PhaseHysPS::buildQpPPSS(), and PorousFlow1PhaseMD_Gaussian::computeQpProperties().

◆ _porepressure_var

template<bool is_ad>

const GenericVariableValue<is_ad>& PorousFlow1PhasePTempl< is_ad >::_porepressure_var

protected

Nodal or quadpoint value of porepressure of the fluid phase.

Definition at line 39 of file PorousFlow1PhaseP.h.

◆ _porepressure_varnum

template<bool is_ad>

const unsigned int PorousFlow1PhasePTempl< is_ad >::_porepressure_varnum

protected

Moose variable number of the porepressure.

Definition at line 43 of file PorousFlow1PhaseP.h.

◆ _saturation

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowVariableBaseTempl< is_ad >::_saturation

protectedinherited

Computed nodal or qp saturation of the phases.

Definition at line 57 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), PorousFlow1PhaseHysP::buildQpPPSS(), PorousFlow2PhaseHysPP::buildQpPPSS(), PorousFlow2PhaseHysPS::buildQpPPSS(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlowHystereticInfo::computeQpProperties(), and PorousFlowHystereticInfo::initQpStatefulProperties().

◆ usingPorousFlowVariableBaseMembers

template<bool is_ad>

PorousFlow1PhasePTempl< is_ad >::usingPorousFlowVariableBaseMembers

protected

Definition at line 49 of file PorousFlow1PhaseP.h.

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

porous_flow/include/materials/PorousFlow1PhaseP.h
porous_flow/src/materials/PorousFlow1PhaseP.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlow1PhasePTempl()

Member Function Documentation

◆ buildQpPPSS()

◆ computeQpProperties()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _dgradp_qp_dgradv

◆ _dgradp_qp_dv

◆ _dgrads_qp_dgradv

◆ _dgrads_qp_dv

◆ _dporepressure_dvar

◆ _dsaturation_dvar

◆ _gradp_qp

◆ _gradp_qp_var

◆ _grads_qp

◆ _num_components

◆ _num_pf_vars

◆ _num_phases

◆ _p_var_num

◆ _pc_uo

◆ _porepressure

◆ _porepressure_var

◆ _porepressure_varnum

◆ _saturation

◆ usingPorousFlowVariableBaseMembers