Applies a flux sink to a boundary. More...

#include <PorousFlowSink.h>

Inheritance diagram for PorousFlowSink:

Public Member Functions
	PorousFlowSink (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeQpResidual () override

virtual Real	computeQpJacobian () override

virtual Real	computeQpOffDiagJacobian (unsigned int jvar) override

Real	jac (unsigned int jvar) const
	Derivative of residual with respect to the jvar variable. More...

virtual Real	multiplier () const
	The flux gets multiplied by this quantity. More...

virtual Real	dmultiplier_dvar (unsigned int pvar) const
	d(multiplier)/d(Porous flow variable pvar) More...

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

const bool	_involves_fluid
	Whether this BC involves fluid (whether the user has supplied a fluid phase number) More...

const unsigned int	_ph
	The phase number. More...

const bool	_use_mass_fraction
	Whether the flux will be multiplied by the mass fraction. More...

const bool	_has_mass_fraction
	Whether there is a "mass_fraction" Material. This is just for error checking. More...

const unsigned int	_sp
	The component number (only used if _use_mass_fraction==true) More...

const bool	_use_mobility
	Whether to multiply the sink flux by permeability*density/viscosity. More...

const bool	_has_mobility
	Whether there are Materials that can form "mobility". This is just for error checking. More...

const bool	_use_relperm
	Whether to multiply the sink flux by relative permeability. More...

const bool	_has_relperm
	Whether there is a "relperm" Material. This is just for error checking. More...

const bool	_use_enthalpy
	Whether to multiply the sink flux by enthalpy. More...

const bool	_has_enthalpy
	Whether there is an "enthalpy" Material. This is just for error checking. More...

const bool	_use_internal_energy
	Whether to multiply the sink flux by internal_energy. More...

const bool	_has_internal_energy
	Whether there is an "internal_energy" Material. This is just for error checking. More...

const bool	_use_thermal_conductivity
	Whether to multiply the sink flux by thermal_conductivity. More...

const bool	_has_thermal_conductivity
	Whether there is an "thermal_conductivity" Material. This is just for error checking. More...

const Function &	_m_func
	The flux. More...

const MaterialProperty< RealTensorValue > *const	_permeability
	Permeability of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > *const	_dpermeability_dvar
	d(Permeability)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< RealTensorValue > > > *const	_dpermeability_dgradvar
	d(Permeability)/d(grad(PorousFlow variable)) More...

const MaterialProperty< std::vector< Real > > *const	_fluid_density_node
	Fluid density for each phase (at the node) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_density_node_dvar
	d(Fluid density for each phase (at the node))/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_fluid_viscosity
	Viscosity of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dfluid_viscosity_dvar
	d(Viscosity of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_relative_permeability
	Relative permeability of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_drelative_permeability_dvar
	d(Relative permeability of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_mass_fractions
	Mass fraction of each component in each phase. More...

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_fractions_dvar
	d(Mass fraction of each component in each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_enthalpy
	Enthalpy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_denthalpy_dvar
	d(enthalpy of each phase)/d(PorousFlow variable) More...

const MaterialProperty< std::vector< Real > > *const	_internal_energy
	Internal_Energy of each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dinternal_energy_dvar
	d(internal_energy of each phase)/d(PorousFlow variable) More...

const MaterialProperty< RealTensorValue > *const	_thermal_conductivity
	Thermal_Conductivity of porous material. More...

const MaterialProperty< std::vector< RealTensorValue > > *const	_dthermal_conductivity_dvar
	d(Thermal_Conductivity)/d(PorousFlow variable) More...

const bool	_perm_derivs
	Flag to check whether permeabiity derivatives are non-zero. More...

Detailed Description

Applies a flux sink to a boundary.

The strength of the flux is specified by flux_function. In addition, this sink can be multiplied by: (1) the relative permeability of the fluid at the nodes (2) perm_nn*density/viscosity (the so-called mobility) where perm_nn is the permeability tensor projected to the normal direction. (3) the mass_fraction of a component at the nodes (4) the enthalpy of the phase (5) the internal energy of the phase (6) the thermal conductivity of the medium

Definition at line 34 of file PorousFlowSink.h.

Constructor & Destructor Documentation

◆ PorousFlowSink()

PorousFlowSink::PorousFlowSink ( const InputParameters & parameters )

Definition at line 80 of file PorousFlowSink.C.

   : IntegratedBC(parameters),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _involves_fluid(isParamValid("fluid_phase")),
     _ph(_involves_fluid ? getParam<unsigned int>("fluid_phase") : 0),
     _use_mass_fraction(isParamValid("mass_fraction_component")),
     _has_mass_fraction(
         hasMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal") &&
         hasMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
             "dPorousFlow_mass_frac_nodal_dvar")),
     _sp(_use_mass_fraction ? getParam<unsigned int>("mass_fraction_component") : 0),
     _use_mobility(getParam<bool>("use_mobility")),
     _has_mobility(
         hasMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp") &&
         hasMaterialProperty<std::vector<RealTensorValue>>("dPorousFlow_permeability_qp_dvar") &&
         hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_fluid_phase_density_nodal_dvar") &&
         hasMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_viscosity_nodal_dvar")),
     _use_relperm(getParam<bool>("use_relperm")),
     _has_relperm(hasMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_nodal") &&
                  hasMaterialProperty<std::vector<std::vector<Real>>>(
                      "dPorousFlow_relative_permeability_nodal_dvar")),
     _use_enthalpy(getParam<bool>("use_enthalpy")),
     _has_enthalpy(hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_enthalpy_nodal") &&
                   hasMaterialProperty<std::vector<std::vector<Real>>>(
                       "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")),
     _use_internal_energy(getParam<bool>("use_internal_energy")),
     _has_internal_energy(
         hasMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_internal_energy_nodal") &&
         hasMaterialProperty<std::vector<std::vector<Real>>>(
             "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")),
     _use_thermal_conductivity(getParam<bool>("use_thermal_conductivity")),
     _has_thermal_conductivity(
         hasMaterialProperty<RealTensorValue>("PorousFlow_thermal_conductivity_qp") &&
         hasMaterialProperty<std::vector<RealTensorValue>>(
             "dPorousFlow_thermal_conductivity_qp_dvar")),
     _m_func(getFunction("flux_function")),
     _permeability(_has_mobility
                       ? &getMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp")
                       : nullptr),
     _dpermeability_dvar(_has_mobility ? &getMaterialProperty<std::vector<RealTensorValue>>(
                                             "dPorousFlow_permeability_qp_dvar")
                                       : nullptr),
     _dpermeability_dgradvar(_has_mobility
                                 ? &getMaterialProperty<std::vector<std::vector<RealTensorValue>>>(
                                       "dPorousFlow_permeability_qp_dgradvar")
                                 : nullptr),
     _fluid_density_node(_has_mobility ? &getMaterialProperty<std::vector<Real>>(
                                             "PorousFlow_fluid_phase_density_nodal")
                                       : nullptr),
     _dfluid_density_node_dvar(_has_mobility ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                   "dPorousFlow_fluid_phase_density_nodal_dvar")
                                             : nullptr),
     _fluid_viscosity(_has_mobility
                          ? &getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_nodal")
                          : nullptr),
     _dfluid_viscosity_dvar(_has_mobility ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                "dPorousFlow_viscosity_nodal_dvar")
                                          : nullptr),
     _relative_permeability(_has_relperm ? &getMaterialProperty<std::vector<Real>>(
                                               "PorousFlow_relative_permeability_nodal")
                                         : nullptr),
     _drelative_permeability_dvar(_has_relperm
                                      ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                            "dPorousFlow_relative_permeability_nodal_dvar")
                                      : nullptr),
     _mass_fractions(_has_mass_fraction ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                              "PorousFlow_mass_frac_nodal")
                                        : nullptr),
     _dmass_fractions_dvar(_has_mass_fraction
                               ? &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
                                     "dPorousFlow_mass_frac_nodal_dvar")
                               : nullptr),
     _enthalpy(_has_enthalpy ? &getMaterialPropertyByName<std::vector<Real>>(
                                   "PorousFlow_fluid_phase_enthalpy_nodal")
                             : nullptr),
     _denthalpy_dvar(_has_enthalpy ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                         "dPorousFlow_fluid_phase_enthalpy_nodal_dvar")
                                   : nullptr),
     _internal_energy(_has_internal_energy ? &getMaterialPropertyByName<std::vector<Real>>(
                                                 "PorousFlow_fluid_phase_internal_energy_nodal")
                                           : nullptr),
     _dinternal_energy_dvar(_has_internal_energy
                                ? &getMaterialPropertyByName<std::vector<std::vector<Real>>>(
                                      "dPorousFlow_fluid_phase_internal_energy_nodal_dvar")
                                : nullptr),
     _thermal_conductivity(_has_thermal_conductivity ? &getMaterialProperty<RealTensorValue>(
                                                           "PorousFlow_thermal_conductivity_qp")
                                                     : nullptr),
     _dthermal_conductivity_dvar(_has_thermal_conductivity
                                     ? &getMaterialProperty<std::vector<RealTensorValue>>(
                                           "dPorousFlow_thermal_conductivity_qp_dvar")
                                     : nullptr),
     _perm_derivs(_dictator.usePermDerivs())
 {
   if (_involves_fluid && _ph >= _dictator.numPhases())
     paramError("fluid_phase",
                "The Dictator proclaims that the maximum phase index in this simulation is ",
                _dictator.numPhases() - 1,
                " whereas you have used ",
                _ph,
                ". Remember that indexing starts at 0. You must try harder.");
  
   if (!_involves_fluid && (_use_mass_fraction || _use_mobility || _use_relperm || _use_enthalpy ||
                            _use_internal_energy))
     mooseError("PorousFlowSink: To use_mass_fraction, use_mobility, use_relperm, use_enthalpy or "
                "use_internal_energy, you must provide a fluid phase number");
  
   if (_use_mass_fraction && _sp >= _dictator.numComponents())
     paramError("mass_fraction_component",
                "The Dictator declares that the maximum fluid component index is ",
                _dictator.numComponents() - 1,
                ", but you have set mass_fraction_component to ",
                _sp,
                ". Remember that indexing starts at 0. Please be assured that the Dictator has "
                "noted your error.");
  
   if (_use_mass_fraction && !_has_mass_fraction)
     mooseError("PorousFlowSink: You have used the use_mass_fraction flag, but you have no "
                "mass_fraction Material");
  
   if (_use_mobility && !_has_mobility)
     mooseError("PorousFlowSink: You have used the use_mobility flag, but there are not the "
                "required Materials for this");
  
   if (_use_relperm && !_has_relperm)
     mooseError(
         "PorousFlowSink: You have used the use_relperm flag, but you have no relperm Material");
  
   if (_use_enthalpy && !_has_enthalpy)
     mooseError(
         "PorousFlowSink: You have used the use_enthalpy flag, but you have no enthalpy Material");
  
   if (_use_internal_energy && !_has_internal_energy)
     mooseError("PorousFlowSink: You have used the use_internal_energy flag, but you have no "
                "internal_energy Material");
  
   if (_use_thermal_conductivity && !_has_thermal_conductivity)
     mooseError("PorousFlowSink: You have used the use_thermal_conductivity flag, but you have no "
                "thermal_conductivity Material");
 }

Member Function Documentation

◆ computeQpJacobian()

Real PorousFlowSink::computeQpJacobian ( )

overrideprotectedvirtual

Definition at line 250 of file PorousFlowSink.C.

 {
   return jac(_var.number());
 }

◆ computeQpOffDiagJacobian()

Real PorousFlowSink::computeQpOffDiagJacobian ( unsigned int jvar )

overrideprotectedvirtual

Definition at line 256 of file PorousFlowSink.C.

 {
   return jac(jvar);
 }

◆ computeQpResidual()

Real PorousFlowSink::computeQpResidual ( )

overrideprotectedvirtual

Definition at line 225 of file PorousFlowSink.C.

 {
   Real flux = _test[_i][_qp] * multiplier();
   if (_use_mobility)
   {
     const Real k =
         ((*_permeability)[_qp] * _normals[_qp]) * _normals[_qp]; // do not upwind permeability
     flux *= (*_fluid_density_node)[_i][_ph] * k / (*_fluid_viscosity)[_i][_ph];
   }
   if (_use_relperm)
     flux *= (*_relative_permeability)[_i][_ph];
   if (_use_mass_fraction)
     flux *= (*_mass_fractions)[_i][_ph][_sp];
   if (_use_enthalpy)
     flux *= (*_enthalpy)[_i][_ph];
   if (_use_internal_energy)
     flux *= (*_internal_energy)[_i][_ph];
   if (_use_thermal_conductivity)
     flux *= ((*_thermal_conductivity)[_qp] * _normals[_qp]) *
             _normals[_qp]; // do not upwind thermal_conductivity
  
   return flux;
 }

◆ dmultiplier_dvar()

Real PorousFlowSink::dmultiplier_dvar ( unsigned int pvar ) const

protectedvirtual

d(multiplier)/d(Porous flow variable pvar)

Reimplemented in PorousFlowHalfCubicSink, PorousFlowHalfGaussianSink, and PorousFlowPiecewiseLinearSink.

Definition at line 344 of file PorousFlowSink.C.

 {
   return 0.0;
 }

Referenced by PorousFlowPiecewiseLinearSink::dmultiplier_dvar(), PorousFlowHalfGaussianSink::dmultiplier_dvar(), PorousFlowHalfCubicSink::dmultiplier_dvar(), and jac().

◆ jac()

Real PorousFlowSink::jac ( unsigned int jvar ) const

protected

Derivative of residual with respect to the jvar variable.

Definition at line 262 of file PorousFlowSink.C.

 {
   if (_dictator.notPorousFlowVariable(jvar))
     return 0.0;
   const unsigned int pvar = _dictator.porousFlowVariableNum(jvar);
  
   // For _i != _j, note:
   // since the only non-upwinded contribution to the residual is
   // from the permeability and thermal_conductivity, the only contribution
   // of the residual at node _i from changing jvar at node _j is through
   // the derivative of permeability or thermal_conductivity
  
   Real flux = _test[_i][_qp] * multiplier();
   Real deriv = _test[_i][_qp] * (_i != _j ? 0.0 : dmultiplier_dvar(pvar));
  
   if (_use_mobility)
   {
     const Real k = ((*_permeability)[_qp] * _normals[_qp]) * _normals[_qp];
     const Real mob = (*_fluid_density_node)[_i][_ph] * k / (*_fluid_viscosity)[_i][_ph];
  
     Real mobprime = 0.0;
     if (_perm_derivs)
     {
       RealTensorValue ktprime = (*_dpermeability_dvar)[_qp][pvar] * _phi[_j][_qp];
       for (unsigned int i = 0; i < LIBMESH_DIM; ++i)
         ktprime += (*_dpermeability_dgradvar)[_qp][i][pvar] * _grad_phi[_j][_qp](i);
       const Real kprime = (ktprime * _normals[_qp]) * _normals[_qp];
  
       mobprime += (*_fluid_density_node)[_i][_ph] * kprime / (*_fluid_viscosity)[_i][_ph];
     }
  
     mobprime +=
         (_i != _j
              ? 0.0
              : (*_dfluid_density_node_dvar)[_i][_ph][pvar] * k / (*_fluid_viscosity)[_i][_ph] -
                    (*_fluid_density_node)[_i][_ph] * k * (*_dfluid_viscosity_dvar)[_i][_ph][pvar] /
                        std::pow((*_fluid_viscosity)[_i][_ph], 2));
     deriv = mob * deriv + mobprime * flux;
     flux *= mob;
   }
   if (_use_relperm)
   {
     const Real relperm_prime = (_i != _j ? 0.0 : (*_drelative_permeability_dvar)[_i][_ph][pvar]);
     deriv = (*_relative_permeability)[_i][_ph] * deriv + relperm_prime * flux;
     flux *= (*_relative_permeability)[_i][_ph];
   }
   if (_use_mass_fraction)
   {
     const Real mf_prime = (_i != _j ? 0.0 : (*_dmass_fractions_dvar)[_i][_ph][_sp][pvar]);
     deriv = (*_mass_fractions)[_i][_ph][_sp] * deriv + mf_prime * flux;
     flux *= (*_mass_fractions)[_i][_ph][_sp];
   }
   if (_use_enthalpy)
   {
     const Real en_prime = (_i != _j ? 0.0 : (*_denthalpy_dvar)[_i][_ph][pvar]);
     deriv = (*_enthalpy)[_i][_ph] * deriv + en_prime * flux;
     flux *= (*_enthalpy)[_i][_ph];
   }
   if (_use_internal_energy)
   {
     const Real ie_prime = (_i != _j ? 0.0 : (*_dinternal_energy_dvar)[_i][_ph][pvar]);
     deriv = (*_internal_energy)[_i][_ph] * deriv + ie_prime * flux;
     flux *= (*_internal_energy)[_i][_ph];
   }
   if (_use_thermal_conductivity)
   {
     const Real tc = ((*_thermal_conductivity)[_qp] * _normals[_qp]) * _normals[_qp];
     const RealTensorValue tctprime = (*_dthermal_conductivity_dvar)[_qp][pvar] * _phi[_j][_qp];
     const Real tcprime = (tctprime * _normals[_qp]) * _normals[_qp];
     deriv = tc * deriv + tcprime * flux;
     // don't need this: flux *= tc;
   }
   return deriv;
 }

Referenced by computeQpJacobian(), and computeQpOffDiagJacobian().

◆ multiplier()

Real PorousFlowSink::multiplier ( ) const

protectedvirtual

The flux gets multiplied by this quantity.

Reimplemented in PorousFlowHalfCubicSink, PorousFlowHalfGaussianSink, and PorousFlowPiecewiseLinearSink.

Definition at line 338 of file PorousFlowSink.C.

 {
   return _m_func.value(_t, _q_point[_qp]);
 }

Referenced by computeQpResidual(), PorousFlowPiecewiseLinearSink::dmultiplier_dvar(), PorousFlowHalfGaussianSink::dmultiplier_dvar(), PorousFlowHalfCubicSink::dmultiplier_dvar(), jac(), PorousFlowPiecewiseLinearSink::multiplier(), PorousFlowHalfGaussianSink::multiplier(), and PorousFlowHalfCubicSink::multiplier().

Member Data Documentation

◆ _denthalpy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_denthalpy_dvar

protected

d(enthalpy of each phase)/d(PorousFlow variable)

Definition at line 132 of file PorousFlowSink.h.

◆ _dfluid_density_node_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_dfluid_density_node_dvar

protected

d(Fluid density for each phase (at the node))/d(PorousFlow variable)

Definition at line 108 of file PorousFlowSink.h.

◆ _dfluid_viscosity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_dfluid_viscosity_dvar

protected

d(Viscosity of each component in each phase)/d(PorousFlow variable)

Definition at line 114 of file PorousFlowSink.h.

◆ _dictator

const PorousFlowDictator& PorousFlowSink::_dictator

protected

PorousFlowDictator UserObject.

Definition at line 45 of file PorousFlowSink.h.

Referenced by jac(), and PorousFlowSink().

◆ _dinternal_energy_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_dinternal_energy_dvar

protected

d(internal_energy of each phase)/d(PorousFlow variable)

Definition at line 138 of file PorousFlowSink.h.

◆ _dmass_fractions_dvar

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowSink::_dmass_fractions_dvar

protected

d(Mass fraction of each component in each phase)/d(PorousFlow variable)

Definition at line 126 of file PorousFlowSink.h.

◆ _dpermeability_dgradvar

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >* const PorousFlowSink::_dpermeability_dgradvar

protected

d(Permeability)/d(grad(PorousFlow variable))

Definition at line 102 of file PorousFlowSink.h.

Referenced by jac().

◆ _dpermeability_dvar

const MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowSink::_dpermeability_dvar

protected

d(Permeability)/d(PorousFlow variable)

Definition at line 99 of file PorousFlowSink.h.

◆ _drelative_permeability_dvar

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_drelative_permeability_dvar

protected

d(Relative permeability of each phase)/d(PorousFlow variable)

Definition at line 120 of file PorousFlowSink.h.

◆ _dthermal_conductivity_dvar

const MaterialProperty<std::vector<RealTensorValue> >* const PorousFlowSink::_dthermal_conductivity_dvar

protected

d(Thermal_Conductivity)/d(PorousFlow variable)

Definition at line 144 of file PorousFlowSink.h.

◆ _enthalpy

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_enthalpy

protected

Enthalpy of each phase.

Definition at line 129 of file PorousFlowSink.h.

◆ _fluid_density_node

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_fluid_density_node

protected

Fluid density for each phase (at the node)

Definition at line 105 of file PorousFlowSink.h.

◆ _fluid_viscosity

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_fluid_viscosity

protected

Viscosity of each component in each phase.

Definition at line 111 of file PorousFlowSink.h.

Referenced by jac().

◆ _has_enthalpy

const bool PorousFlowSink::_has_enthalpy

protected

Whether there is an "enthalpy" Material. This is just for error checking.

Definition at line 78 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_internal_energy

const bool PorousFlowSink::_has_internal_energy

protected

Whether there is an "internal_energy" Material. This is just for error checking.

Definition at line 84 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_mass_fraction

const bool PorousFlowSink::_has_mass_fraction

protected

Whether there is a "mass_fraction" Material. This is just for error checking.

Definition at line 57 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_mobility

const bool PorousFlowSink::_has_mobility

protected

Whether there are Materials that can form "mobility". This is just for error checking.

Definition at line 66 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_relperm

const bool PorousFlowSink::_has_relperm

protected

Whether there is a "relperm" Material. This is just for error checking.

Definition at line 72 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _has_thermal_conductivity

const bool PorousFlowSink::_has_thermal_conductivity

protected

Whether there is an "thermal_conductivity" Material. This is just for error checking.

Definition at line 90 of file PorousFlowSink.h.

Referenced by PorousFlowSink().

◆ _internal_energy

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_internal_energy

protected

Internal_Energy of each phase.

Definition at line 135 of file PorousFlowSink.h.

◆ _involves_fluid

const bool PorousFlowSink::_involves_fluid

protected

Whether this BC involves fluid (whether the user has supplied a fluid phase number)

Definition at line 48 of file PorousFlowSink.h.

Referenced by PorousFlowSinkPTDefiner::dptVar(), PorousFlowSink(), PorousFlowSinkPTDefiner::PorousFlowSinkPTDefiner(), and PorousFlowSinkPTDefiner::ptVar().

◆ _m_func

const Function& PorousFlowSink::_m_func

protected

The flux.

Definition at line 93 of file PorousFlowSink.h.

Referenced by multiplier().

◆ _mass_fractions

const MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowSink::_mass_fractions

protected

Mass fraction of each component in each phase.

Definition at line 123 of file PorousFlowSink.h.

◆ _perm_derivs

const bool PorousFlowSink::_perm_derivs

protected

Flag to check whether permeabiity derivatives are non-zero.

Definition at line 156 of file PorousFlowSink.h.

Referenced by jac().

◆ _permeability

const MaterialProperty<RealTensorValue>* const PorousFlowSink::_permeability

protected

Permeability of porous material.

Definition at line 96 of file PorousFlowSink.h.

◆ _ph

const unsigned int PorousFlowSink::_ph

protected

The phase number.

Definition at line 51 of file PorousFlowSink.h.

Referenced by computeQpResidual(), PorousFlowSinkPTDefiner::dptVar(), jac(), PorousFlowSink(), and PorousFlowSinkPTDefiner::ptVar().

◆ _relative_permeability

const MaterialProperty<std::vector<Real> >* const PorousFlowSink::_relative_permeability

protected

Relative permeability of each phase.

Definition at line 117 of file PorousFlowSink.h.

◆ _sp

const unsigned int PorousFlowSink::_sp

protected

The component number (only used if _use_mass_fraction==true)

Definition at line 60 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _thermal_conductivity

const MaterialProperty<RealTensorValue>* const PorousFlowSink::_thermal_conductivity

protected

Thermal_Conductivity of porous material.

Definition at line 141 of file PorousFlowSink.h.

◆ _use_enthalpy

const bool PorousFlowSink::_use_enthalpy

protected

Whether to multiply the sink flux by enthalpy.

Definition at line 75 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_internal_energy

const bool PorousFlowSink::_use_internal_energy

protected

Whether to multiply the sink flux by internal_energy.

Definition at line 81 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_mass_fraction

const bool PorousFlowSink::_use_mass_fraction

protected

Whether the flux will be multiplied by the mass fraction.

Definition at line 54 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_mobility

const bool PorousFlowSink::_use_mobility

protected

Whether to multiply the sink flux by permeability*density/viscosity.

Definition at line 63 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_relperm

const bool PorousFlowSink::_use_relperm

protected

Whether to multiply the sink flux by relative permeability.

Definition at line 69 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

◆ _use_thermal_conductivity

const bool PorousFlowSink::_use_thermal_conductivity

protected

Whether to multiply the sink flux by thermal_conductivity.

Definition at line 87 of file PorousFlowSink.h.

Referenced by computeQpResidual(), jac(), and PorousFlowSink().

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

porous_flow/include/bcs/PorousFlowSink.h
porous_flow/src/bcs/PorousFlowSink.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowSink()

Member Function Documentation

◆ computeQpJacobian()

◆ computeQpOffDiagJacobian()

◆ computeQpResidual()

◆ dmultiplier_dvar()

◆ jac()

◆ multiplier()

Member Data Documentation

◆ _denthalpy_dvar

◆ _dfluid_density_node_dvar

◆ _dfluid_viscosity_dvar

◆ _dictator

◆ _dinternal_energy_dvar

◆ _dmass_fractions_dvar

◆ _dpermeability_dgradvar

◆ _dpermeability_dvar

◆ _drelative_permeability_dvar

◆ _dthermal_conductivity_dvar

◆ _enthalpy

◆ _fluid_density_node

◆ _fluid_viscosity

◆ _has_enthalpy

◆ _has_internal_energy

◆ _has_mass_fraction

◆ _has_mobility

◆ _has_relperm

◆ _has_thermal_conductivity

◆ _internal_energy

◆ _involves_fluid

◆ _m_func

◆ _mass_fractions

◆ _perm_derivs

◆ _permeability

◆ _ph

◆ _relative_permeability

◆ _sp

◆ _thermal_conductivity

◆ _use_enthalpy

◆ _use_internal_energy

◆ _use_mass_fraction

◆ _use_mobility

◆ _use_relperm

◆ _use_thermal_conductivity