Time derivative of fluid mass suitable for fully-saturated, single-phase, single-component simulations. More...

#include <PorousFlowFullySaturatedMassTimeDerivative.h>

Inheritance diagram for PorousFlowFullySaturatedMassTimeDerivative:

Public Member Functions
	PorousFlowFullySaturatedMassTimeDerivative (const InputParameters &parameters)

Protected Types
enum	CouplingTypeEnum { CouplingTypeEnum::Hydro, CouplingTypeEnum::ThermoHydro, CouplingTypeEnum::HydroMechanical, CouplingTypeEnum::ThermoHydroMechanical }
	Determines whether mechanical and/or thermal contributions should be added to the residual. More...

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Real	computeQpJac (unsigned int pvar)
	Jacobian contribution for the PorousFlow variable pvar. More...

Protected Attributes
const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

const bool	_var_is_porflow_var
	Whether the Variable for this Kernel is a PorousFlow variable. More...

const bool	_multiply_by_density
	If true then the Kernel is the time derivative of the fluid mass, otherwise it is the derivative of the fluid volume. More...

enum PorousFlowFullySaturatedMassTimeDerivative::CouplingTypeEnum	_coupling_type

const bool	_includes_thermal
	Whether thermal contributions should be added to the residual. More...

const bool	_includes_mechanical
	Whether mechanical contributions should be added to the residual. More...

const Real	_biot_coefficient
	Biot coefficient (used in simulations involving Mechanical deformations) More...

const MaterialProperty< Real > &	_biot_modulus
	Constant Biot modulus. More...

const MaterialProperty< Real > *const	_thermal_coeff
	Constant volumetric thermal expansion coefficient. More...

const MaterialProperty< std::vector< Real > > *const	_fluid_density
	Quadpoint fluid density for each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_dvar
	derivative of fluid density for each phase with respect to the PorousFlow variables More...

const MaterialProperty< std::vector< Real > > &	_pp
	Quadpoint pore pressure in each phase. More...

const MaterialProperty< std::vector< Real > > &	_pp_old
	Old value of quadpoint pore pressure in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dpp_dvar
	Derivative of porepressure in each phase wrt the PorousFlow variables. More...

const MaterialProperty< Real > *const	_temperature
	Quadpoint temperature. More...

const MaterialProperty< Real > *const	_temperature_old
	Old value of quadpoint temperature. More...

const MaterialProperty< std::vector< Real > > *const	_dtemperature_dvar
	Derivative of temperature wrt the PorousFlow variables. More...

const MaterialProperty< Real > *const	_strain_rate
	Strain rate. More...

const MaterialProperty< std::vector< RealGradient > > *const	_dstrain_rate_dvar
	Derivative of strain rate wrt the PorousFlow variables. More...

Detailed Description

Time derivative of fluid mass suitable for fully-saturated, single-phase, single-component simulations.

No mass-lumping is used

Definition at line 25 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Member Enumeration Documentation

◆ CouplingTypeEnum

enum PorousFlowFullySaturatedMassTimeDerivative::CouplingTypeEnum

strongprotected

Determines whether mechanical and/or thermal contributions should be added to the residual.

Enumerator
Hydro
ThermoHydro
HydroMechanical
ThermoHydroMechanical

Definition at line 48 of file PorousFlowFullySaturatedMassTimeDerivative.h.

                                     {
     Hydro,
     ThermoHydro,
     HydroMechanical,
     ThermoHydroMechanical
   } _coupling_type;

Constructor & Destructor Documentation

◆ PorousFlowFullySaturatedMassTimeDerivative()

PorousFlowFullySaturatedMassTimeDerivative::PorousFlowFullySaturatedMassTimeDerivative ( const InputParameters & parameters )

Definition at line 42 of file PorousFlowFullySaturatedMassTimeDerivative.C.

   : TimeKernel(parameters),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _var_is_porflow_var(_dictator.isPorousFlowVariable(_var.number())),
     _multiply_by_density(getParam<bool>("multiply_by_density")),
     _coupling_type(getParam<MooseEnum>("coupling_type").getEnum<CouplingTypeEnum>()),
     _includes_thermal(_coupling_type == CouplingTypeEnum::ThermoHydro ||
                       _coupling_type == CouplingTypeEnum::ThermoHydroMechanical),
     _includes_mechanical(_coupling_type == CouplingTypeEnum::HydroMechanical ||
                          _coupling_type == CouplingTypeEnum::ThermoHydroMechanical),
     _biot_coefficient(getParam<Real>("biot_coefficient")),
     _biot_modulus(getMaterialProperty<Real>("PorousFlow_constant_biot_modulus_qp")),
     _thermal_coeff(_includes_thermal ? &getMaterialProperty<Real>(
                                            "PorousFlow_constant_thermal_expansion_coefficient_qp")
                                      : nullptr),
     _fluid_density(_multiply_by_density ? &getMaterialProperty<std::vector<Real>>(
                                               "PorousFlow_fluid_phase_density_qp")
                                         : nullptr),
     _dfluid_density_dvar(_multiply_by_density
                              ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                    "dPorousFlow_fluid_phase_density_qp_dvar")
                              : nullptr),
     _pp(getMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp")),
     _pp_old(getMaterialPropertyOld<std::vector<Real>>("PorousFlow_porepressure_qp")),
     _dpp_dvar(
         getMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_porepressure_qp_dvar")),
     _temperature(_includes_thermal ? &getMaterialProperty<Real>("PorousFlow_temperature_qp")
                                    : nullptr),
     _temperature_old(_includes_thermal ? &getMaterialPropertyOld<Real>("PorousFlow_temperature_qp")
                                        : nullptr),
     _dtemperature_dvar(_includes_thermal ? &getMaterialProperty<std::vector<Real>>(
                                                "dPorousFlow_temperature_qp_dvar")
                                          : nullptr),
     _strain_rate(_includes_mechanical
                      ? &getMaterialProperty<Real>("PorousFlow_volumetric_strain_rate_qp")
                      : nullptr),
     _dstrain_rate_dvar(_includes_mechanical ? &getMaterialProperty<std::vector<RealGradient>>(
                                                   "dPorousFlow_volumetric_strain_rate_qp_dvar")
                                             : nullptr)
 {
   if (_dictator.numComponents() != 1 || _dictator.numPhases() != 1)
     mooseError("PorousFlowFullySaturatedMassTimeDerivative is only applicable to single-phase, "
                "single-component fluid-flow problems.  The Dictator proclaims that you have more "
                "than one phase or more than one fluid component.  The Dictator does not take such "
                "mistakes lightly");
 }

Member Function Documentation

◆ computeQpJac()

Real PorousFlowFullySaturatedMassTimeDerivative::computeQpJac ( unsigned int pvar )

protected

Jacobian contribution for the PorousFlow variable pvar.

Definition at line 123 of file PorousFlowFullySaturatedMassTimeDerivative.C.

 {
   const unsigned phase = 0;
   Real volume = (_pp[_qp][phase] - _pp_old[_qp][phase]) / _dt / _biot_modulus[_qp];
   Real dvolume = _dpp_dvar[_qp][phase][pvar] / _dt / _biot_modulus[_qp] * _phi[_j][_qp];
   if (_includes_thermal)
   {
     volume -= (*_thermal_coeff)[_qp] * ((*_temperature)[_qp] - (*_temperature_old)[_qp]) / _dt;
     dvolume -= (*_thermal_coeff)[_qp] * (*_dtemperature_dvar)[_qp][pvar] / _dt * _phi[_j][_qp];
   }
   if (_includes_mechanical)
   {
     volume += _biot_coefficient * (*_strain_rate)[_qp];
     dvolume += _biot_coefficient * (*_dstrain_rate_dvar)[_qp][pvar] * _grad_phi[_j][_qp];
   }
   if (_multiply_by_density)
     return _test[_i][_qp] * ((*_fluid_density)[_qp][phase] * dvolume +
                              (*_dfluid_density_dvar)[_qp][phase][pvar] * _phi[_j][_qp] * volume);
   return _test[_i][_qp] * dvolume;
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ computeQpJacobian()

Real PorousFlowFullySaturatedMassTimeDerivative::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 105 of file PorousFlowFullySaturatedMassTimeDerivative.C.

 {
   // If the variable is not a PorousFlow variable (very unusual), the diag Jacobian terms are 0
   if (!_var_is_porflow_var)
     return 0.0;
   return computeQpJac(_dictator.porousFlowVariableNum(_var.number()));
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowFullySaturatedMassTimeDerivative::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Definition at line 114 of file PorousFlowFullySaturatedMassTimeDerivative.C.

 {
   // If the variable is not a PorousFlow variable, the OffDiag Jacobian terms are 0
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   return computeQpJac(_dictator.porousFlowVariableNum(jvar));
 }

◆ computeQpResidual()

Real PorousFlowFullySaturatedMassTimeDerivative::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 91 of file PorousFlowFullySaturatedMassTimeDerivative.C.

 {
   const unsigned phase = 0;
   Real volume = (_pp[_qp][phase] - _pp_old[_qp][phase]) / _dt / _biot_modulus[_qp];
   if (_includes_thermal)
     volume -= (*_thermal_coeff)[_qp] * ((*_temperature)[_qp] - (*_temperature_old)[_qp]) / _dt;
   if (_includes_mechanical)
     volume += _biot_coefficient * (*_strain_rate)[_qp];
   if (_multiply_by_density)
     return _test[_i][_qp] * (*_fluid_density)[_qp][phase] * volume;
   return _test[_i][_qp] * volume;
 }

Member Data Documentation

◆ _biot_coefficient

const Real PorousFlowFullySaturatedMassTimeDerivative::_biot_coefficient

protected

Biot coefficient (used in simulations involving Mechanical deformations)

Definition at line 62 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _biot_modulus

const MaterialProperty<Real>& PorousFlowFullySaturatedMassTimeDerivative::_biot_modulus

protected

Constant Biot modulus.

Definition at line 65 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _coupling_type

enum PorousFlowFullySaturatedMassTimeDerivative::CouplingTypeEnum PorousFlowFullySaturatedMassTimeDerivative::_coupling_type

protected

◆ _dfluid_density_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowFullySaturatedMassTimeDerivative::_dfluid_density_dvar

protected

derivative of fluid density for each phase with respect to the PorousFlow variables

Definition at line 74 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _dictator

const PorousFlowDictator& PorousFlowFullySaturatedMassTimeDerivative::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 39 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJacobian(), computeQpOffDiagJacobian(), and PorousFlowFullySaturatedMassTimeDerivative().

◆ _dpp_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowFullySaturatedMassTimeDerivative::_dpp_dvar

protected

Derivative of porepressure in each phase wrt the PorousFlow variables.

Definition at line 83 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac().

◆ _dstrain_rate_dvar

const MaterialProperty<std::vector<RealGradient> >* const PorousFlowFullySaturatedMassTimeDerivative::_dstrain_rate_dvar

protected

Derivative of strain rate wrt the PorousFlow variables.

Definition at line 98 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _dtemperature_dvar

const MaterialProperty<std::vector<Real> >* const PorousFlowFullySaturatedMassTimeDerivative::_dtemperature_dvar

protected

Derivative of temperature wrt the PorousFlow variables.

Definition at line 92 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _fluid_density

const MaterialProperty<std::vector<Real> >* const PorousFlowFullySaturatedMassTimeDerivative::_fluid_density

protected

Quadpoint fluid density for each phase.

Definition at line 71 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _includes_mechanical

const bool PorousFlowFullySaturatedMassTimeDerivative::_includes_mechanical

protected

Whether mechanical contributions should be added to the residual.

Definition at line 59 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _includes_thermal

const bool PorousFlowFullySaturatedMassTimeDerivative::_includes_thermal

protected

Whether thermal contributions should be added to the residual.

Definition at line 56 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _multiply_by_density

const bool PorousFlowFullySaturatedMassTimeDerivative::_multiply_by_density

protected

If true then the Kernel is the time derivative of the fluid mass, otherwise it is the derivative of the fluid volume.

Definition at line 45 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _pp

const MaterialProperty<std::vector<Real> >& PorousFlowFullySaturatedMassTimeDerivative::_pp

protected

Quadpoint pore pressure in each phase.

Definition at line 77 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _pp_old

const MaterialProperty<std::vector<Real> >& PorousFlowFullySaturatedMassTimeDerivative::_pp_old

protected

Old value of quadpoint pore pressure in each phase.

Definition at line 80 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJac(), and computeQpResidual().

◆ _strain_rate

const MaterialProperty<Real>* const PorousFlowFullySaturatedMassTimeDerivative::_strain_rate

protected

Strain rate.

Definition at line 95 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _temperature

const MaterialProperty<Real>* const PorousFlowFullySaturatedMassTimeDerivative::_temperature

protected

Quadpoint temperature.

Definition at line 86 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _temperature_old

const MaterialProperty<Real>* const PorousFlowFullySaturatedMassTimeDerivative::_temperature_old

protected

Old value of quadpoint temperature.

Definition at line 89 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _thermal_coeff

const MaterialProperty<Real>* const PorousFlowFullySaturatedMassTimeDerivative::_thermal_coeff

protected

Constant volumetric thermal expansion coefficient.

Definition at line 68 of file PorousFlowFullySaturatedMassTimeDerivative.h.

◆ _var_is_porflow_var

const bool PorousFlowFullySaturatedMassTimeDerivative::_var_is_porflow_var

protected

Whether the Variable for this Kernel is a PorousFlow variable.

Definition at line 42 of file PorousFlowFullySaturatedMassTimeDerivative.h.

Referenced by computeQpJacobian().

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

porous_flow/include/kernels/PorousFlowFullySaturatedMassTimeDerivative.h
porous_flow/src/kernels/PorousFlowFullySaturatedMassTimeDerivative.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CouplingTypeEnum

Constructor & Destructor Documentation

◆ PorousFlowFullySaturatedMassTimeDerivative()

Member Function Documentation

◆ computeQpJac()

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

Member Data Documentation

◆ _biot_coefficient

◆ _biot_modulus

◆ _coupling_type

◆ _dfluid_density_dvar

◆ _dictator

◆ _dpp_dvar

◆ _dstrain_rate_dvar

◆ _dtemperature_dvar

◆ _fluid_density

◆ _includes_mechanical

◆ _includes_thermal

◆ _multiply_by_density

◆ _pp

◆ _pp_old

◆ _strain_rate

◆ _temperature

◆ _temperature_old

◆ _thermal_coeff

◆ _var_is_porflow_var