Material designed to calculate fluid-phase porepressures and saturations at nodes and qps using a specified capillary pressure formulation. More...

#include <PorousFlow2PhasePS.h>

Inheritance diagram for PorousFlow2PhasePS:

[legend]

Public Member Functions
	PorousFlow2PhasePS (const InputParameters &parameters)

Protected Member Functions
void	buildQpPPSS ()
	Assemble std::vectors of porepressure and saturation at the nodes and quadpoints. More...

virtual void	initQpStatefulProperties () override

virtual void	computeQpProperties () override

Protected Attributes
const VariableValue &	_phase0_porepressure
	Nodal or quadpoint value of porepressure of phase zero (eg, the liquid phase) More...

const VariableGradient &	_phase0_gradp_qp
	Gradient(phase0_porepressure) at the qps. More...

const unsigned int	_phase0_porepressure_varnum
	Moose variable number of the phase0 porepressure. More...

const unsigned int	_pvar
	PorousFlow variable number of the phase0 porepressure. More...

const VariableValue &	_phase1_saturation
	Nodal or quadpoint value of saturation of phase one (eg, the gas phase) More...

const VariableGradient &	_phase1_grads_qp
	Gradient(phase1_saturation) at the qps. More...

const unsigned int	_phase1_saturation_varnum
	Moose variable number of the phase1 saturation. More...

const unsigned int	_svar
	PorousFlow variable number of the phase1 saturation. More...

const PorousFlowCapillaryPressure &	_pc_uo
	Capillary pressure UserObject. 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...

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

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

MaterialProperty< std::vector< RealGradient > > *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...

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

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

MaterialProperty< std::vector< RealGradient > > *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 porepressures and saturations at nodes and qps using a specified capillary pressure formulation.

Definition at line 24 of file PorousFlow2PhasePS.h.

Constructor & Destructor Documentation

◆ PorousFlow2PhasePS()

PorousFlow2PhasePS::PorousFlow2PhasePS ( const InputParameters & parameters )

Definition at line 32 of file PorousFlow2PhasePS.C.

   : PorousFlowVariableBase(parameters),
  
     _phase0_porepressure(_nodal_material ? coupledDofValues("phase0_porepressure")
                                          : coupledValue("phase0_porepressure")),
     _phase0_gradp_qp(coupledGradient("phase0_porepressure")),
     _phase0_porepressure_varnum(coupled("phase0_porepressure")),
     _pvar(_dictator.isPorousFlowVariable(_phase0_porepressure_varnum)
               ? _dictator.porousFlowVariableNum(_phase0_porepressure_varnum)
               : 0),
  
     _phase1_saturation(_nodal_material ? coupledDofValues("phase1_saturation")
                                        : coupledValue("phase1_saturation")),
     _phase1_grads_qp(coupledGradient("phase1_saturation")),
     _phase1_saturation_varnum(coupled("phase1_saturation")),
     _svar(_dictator.isPorousFlowVariable(_phase1_saturation_varnum)
               ? _dictator.porousFlowVariableNum(_phase1_saturation_varnum)
               : 0),
  
     _pc_uo(getUserObject<PorousFlowCapillaryPressure>("capillary_pressure"))
 {
   if (_dictator.numPhases() != 2)
     mooseError("The Dictator proclaims that the number of phases is ",
                _dictator.numPhases(),
                " whereas PorousFlow2PhasePS can only be used for 2-phase simulation.  Be aware "
                "that the Dictator has noted your mistake.");
 }

Member Function Documentation

◆ buildQpPPSS()

void PorousFlow2PhasePS::buildQpPPSS ( )

protected

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

Definition at line 117 of file PorousFlow2PhasePS.C.

 {
   _saturation[_qp][0] = 1.0 - _phase1_saturation[_qp];
   _saturation[_qp][1] = _phase1_saturation[_qp];
   const Real pc = _pc_uo.capillaryPressure(1.0 - _phase1_saturation[_qp]);
   _porepressure[_qp][0] = _phase0_porepressure[_qp];
   _porepressure[_qp][1] = _phase0_porepressure[_qp] + pc;
 }

Referenced by computeQpProperties(), and initQpStatefulProperties().

◆ computeQpProperties()

void PorousFlow2PhasePS::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowVariableBase.

Definition at line 68 of file PorousFlow2PhasePS.C.

 {
   // size stuff correctly and prepare the derivative matrices with zeroes
   PorousFlowVariableBase::computeQpProperties();
  
   buildQpPPSS();
   const Real dpc = _pc_uo.dCapillaryPressure(1.0 - _phase1_saturation[_qp]);
  
   if (!_nodal_material)
   {
     (*_grads_qp)[_qp][0] = -_phase1_grads_qp[_qp];
     (*_grads_qp)[_qp][1] = _phase1_grads_qp[_qp];
     (*_gradp_qp)[_qp][0] = _phase0_gradp_qp[_qp];
     (*_gradp_qp)[_qp][1] = _phase0_gradp_qp[_qp] - dpc * (*_grads_qp)[_qp][1];
   }
  
   // _porepressure depends on _phase0_porepressure, and its derivative is 1
   if (_dictator.isPorousFlowVariable(_phase0_porepressure_varnum))
   {
     // _phase0_porepressure is a PorousFlow variable
     for (unsigned phase = 0; phase < _num_phases; ++phase)
     {
       _dporepressure_dvar[_qp][phase][_pvar] = 1.0;
       if (!_nodal_material)
         (*_dgradp_qp_dgradv)[_qp][phase][_pvar] = 1.0;
     }
   }
  
   // _saturation is only dependent on _phase1_saturation, and its derivative is +/- 1
   if (_dictator.isPorousFlowVariable(_phase1_saturation_varnum))
   {
     // _phase1_saturation is a PorousFlow variable
     // _phase1_porepressure depends on saturation through the capillary pressure function
     _dsaturation_dvar[_qp][0][_svar] = -1.0;
     _dsaturation_dvar[_qp][1][_svar] = 1.0;
     _dporepressure_dvar[_qp][1][_svar] = -dpc;
  
     if (!_nodal_material)
     {
       (*_dgrads_qp_dgradv)[_qp][0][_svar] = -1.0;
       (*_dgrads_qp_dgradv)[_qp][1][_svar] = 1.0;
       const Real d2pc_qp = _pc_uo.d2CapillaryPressure(1.0 - _phase1_saturation[_qp]);
       (*_dgradp_qp_dv)[_qp][1][_svar] = d2pc_qp * (*_grads_qp)[_qp][1];
       (*_dgradp_qp_dgradv)[_qp][1][_svar] = -dpc;
     }
   }
 }

◆ initQpStatefulProperties()

void PorousFlow2PhasePS::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented from PorousFlowVariableBase.

Definition at line 61 of file PorousFlow2PhasePS.C.

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

Member Data Documentation

◆ _dgradp_qp_dgradv

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBase::_dgradp_qp_dgradv

protectedinherited

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

Definition at line 53 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

◆ _dgradp_qp_dv

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBase::_dgradp_qp_dv

protectedinherited

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

Definition at line 56 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dgradv

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowVariableBase::_dgrads_qp_dgradv

protectedinherited

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

Definition at line 68 of file PorousFlowVariableBase.h.

◆ _dgrads_qp_dv

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowVariableBase::_dgrads_qp_dv

protectedinherited

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

Definition at line 71 of file PorousFlowVariableBase.h.

◆ _dporepressure_dvar

MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowVariableBase::_dporepressure_dvar

protectedinherited

d(porepressure)/d(PorousFlow variable)

Definition at line 47 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseFullySaturated::computeQpProperties(), PorousFlow2PhasePP::computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlow1PhaseP::computeQpProperties(), PorousFlowVariableBase::computeQpProperties(), computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

◆ _dsaturation_dvar

MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowVariableBase::_dsaturation_dvar

protectedinherited

d(saturation)/d(PorousFlow variable)

Definition at line 62 of file PorousFlowVariableBase.h.

Referenced by PorousFlow2PhasePP::computeQpProperties(), PorousFlowVariableBase::computeQpProperties(), PorousFlow1PhaseP::computeQpProperties(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), and PorousFlowFluidState::computeQpProperties().

◆ _gradp_qp

MaterialProperty<std::vector<RealGradient> >* const PorousFlowVariableBase::_gradp_qp

protectedinherited

Grad(p) at the quadpoints.

Definition at line 50 of file PorousFlowVariableBase.h.

◆ _grads_qp

MaterialProperty<std::vector<RealGradient> >* const PorousFlowVariableBase::_grads_qp

protectedinherited

Grad(s) at the quadpoints.

Definition at line 65 of file PorousFlowVariableBase.h.

◆ _num_components

const unsigned int PorousFlowVariableBase::_num_components

protectedinherited

Number of components.

Definition at line 38 of file PorousFlowVariableBase.h.

Referenced by PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), PorousFlowFluidState::initQpStatefulProperties(), PorousFlowFluidState::PorousFlowFluidState(), PorousFlowFluidStateSingleComponent::PorousFlowFluidStateSingleComponent(), PorousFlowFluidStateSingleComponent::setMaterialVectorSize(), and PorousFlowFluidState::setMaterialVectorSize().

◆ _num_pf_vars

const unsigned int PorousFlowVariableBase::_num_pf_vars

protectedinherited

Number of PorousFlow variables.

Definition at line 41 of file PorousFlowVariableBase.h.

Referenced by PorousFlowVariableBase::computeQpProperties(), PorousFlowFluidStateSingleComponent::setMaterialVectorSize(), and PorousFlowFluidState::setMaterialVectorSize().

◆ _num_phases

const unsigned int PorousFlowVariableBase::_num_phases

protectedinherited

Number of phases.

Definition at line 35 of file PorousFlowVariableBase.h.

◆ _pc_uo

const PorousFlowCapillaryPressure& PorousFlow2PhasePS::_pc_uo

protected

Capillary pressure UserObject.

Definition at line 56 of file PorousFlow2PhasePS.h.

Referenced by buildQpPPSS(), and computeQpProperties().

◆ _phase0_gradp_qp

const VariableGradient& PorousFlow2PhasePS::_phase0_gradp_qp

protected

Gradient(phase0_porepressure) at the qps.

Definition at line 42 of file PorousFlow2PhasePS.h.

Referenced by computeQpProperties().

◆ _phase0_porepressure

const VariableValue& PorousFlow2PhasePS::_phase0_porepressure

protected

Nodal or quadpoint value of porepressure of phase zero (eg, the liquid phase)

Definition at line 40 of file PorousFlow2PhasePS.h.

Referenced by buildQpPPSS().

◆ _phase0_porepressure_varnum

const unsigned int PorousFlow2PhasePS::_phase0_porepressure_varnum

protected

Moose variable number of the phase0 porepressure.

Definition at line 44 of file PorousFlow2PhasePS.h.

Referenced by computeQpProperties().

◆ _phase1_grads_qp

const VariableGradient& PorousFlow2PhasePS::_phase1_grads_qp

protected

Gradient(phase1_saturation) at the qps.

Definition at line 50 of file PorousFlow2PhasePS.h.

Referenced by computeQpProperties().

◆ _phase1_saturation

const VariableValue& PorousFlow2PhasePS::_phase1_saturation

protected

Nodal or quadpoint value of saturation of phase one (eg, the gas phase)

Definition at line 48 of file PorousFlow2PhasePS.h.

Referenced by buildQpPPSS(), and computeQpProperties().

◆ _phase1_saturation_varnum

const unsigned int PorousFlow2PhasePS::_phase1_saturation_varnum

protected

Moose variable number of the phase1 saturation.

Definition at line 52 of file PorousFlow2PhasePS.h.

Referenced by computeQpProperties().

◆ _porepressure

MaterialProperty<std::vector<Real> >& PorousFlowVariableBase::_porepressure

protectedinherited

Computed nodal or quadpoint values of porepressure of the phases.

Definition at line 44 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), buildQpPPSS(), PorousFlow1PhaseFullySaturated::buildQpPPSS(), PorousFlow1PhaseP::buildQpPPSS(), PorousFlow2PhasePP::buildQpPPSS(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlowVariableBase::computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), PorousFlowVariableBase::initQpStatefulProperties(), PorousFlowFluidStateSingleComponent::initQpStatefulProperties(), and PorousFlowFluidState::initQpStatefulProperties().

◆ _pvar

const unsigned int PorousFlow2PhasePS::_pvar

protected

PorousFlow variable number of the phase0 porepressure.

Definition at line 46 of file PorousFlow2PhasePS.h.

Referenced by computeQpProperties().

◆ _saturation

MaterialProperty<std::vector<Real> >& PorousFlowVariableBase::_saturation

protectedinherited

Computed nodal or qp saturation of the phases.

Definition at line 59 of file PorousFlowVariableBase.h.

Referenced by PorousFlow1PhaseMD_Gaussian::buildPS(), buildQpPPSS(), PorousFlow1PhaseFullySaturated::buildQpPPSS(), PorousFlow1PhaseP::buildQpPPSS(), PorousFlow2PhasePP::buildQpPPSS(), PorousFlow1PhaseMD_Gaussian::computeQpProperties(), PorousFlowVariableBase::computeQpProperties(), PorousFlowFluidStateSingleComponent::computeQpProperties(), PorousFlowFluidState::computeQpProperties(), PorousFlowVariableBase::initQpStatefulProperties(), PorousFlowFluidStateSingleComponent::initQpStatefulProperties(), and PorousFlowFluidState::initQpStatefulProperties().

◆ _svar

const unsigned int PorousFlow2PhasePS::_svar

protected

PorousFlow variable number of the phase1 saturation.

Definition at line 54 of file PorousFlow2PhasePS.h.

Referenced by computeQpProperties().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlow2PhasePS()

Member Function Documentation

◆ buildQpPPSS()

◆ computeQpProperties()

◆ initQpStatefulProperties()

Member Data Documentation

◆ _dgradp_qp_dgradv

◆ _dgradp_qp_dv

◆ _dgrads_qp_dgradv

◆ _dgrads_qp_dv

◆ _dporepressure_dvar

◆ _dsaturation_dvar

◆ _gradp_qp

◆ _grads_qp

◆ _num_components

◆ _num_pf_vars

◆ _num_phases

◆ _pc_uo

◆ _phase0_gradp_qp

◆ _phase0_porepressure

◆ _phase0_porepressure_varnum

◆ _phase1_grads_qp

◆ _phase1_saturation

◆ _phase1_saturation_varnum

◆ _porepressure

◆ _pvar

◆ _saturation

◆ _svar