Material designed to form a std::vector of property and derivatives of these wrt the nonlinear variables from the individual phase properties. More...

#include <PorousFlowJoiner.h>

Inheritance diagram for PorousFlowJoinerTempl< is_ad >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

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

Protected Attributes
const std::string	_pf_prop
	Name of material property to be joined.

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dporepressure_dvar
	Derivatives of porepressure variable wrt PorousFlow variables at the qps or nodes.

const MaterialProperty< std::vector< std::vector< Real > > > *const	_dsaturation_dvar
	Derivatives of saturation variable wrt PorousFlow variables at the qps or nodes.

const MaterialProperty< std::vector< Real > > *const	_dtemperature_dvar
	Derivatives of temperature variable wrt PorousFlow variables at the qps or nodes.

const bool	_has_mass_fraction
	Flag to check whether mass fractions are used.

const MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_fraction_dvar
	Derivatives of mass fraction variable wrt PorousFlow variables at the qps or nodes.

GenericMaterialProperty< std::vector< Real >, is_ad > &	_property
	Computed property of the phase.

MaterialProperty< std::vector< std::vector< Real > > > *const	_dproperty_dvar
	d(property)/d(PorousFlow variable)

std::vector< const GenericMaterialProperty< Real, is_ad > * >	_phase_property
	Property of each phase.

std::vector< const MaterialProperty< Real > * >	_dphase_property_dp
	d(property of each phase)/d(pressure)

std::vector< const MaterialProperty< Real > * >	_dphase_property_ds
	d(property of each phase)/d(saturation)

std::vector< const MaterialProperty< Real > * >	_dphase_property_dt
	d(property of each phase)/d(temperature)

std::vector< const MaterialProperty< Real > * >	_dphase_property_dX
	d(property of each phase)/d(mass fraction)

const unsigned int	_num_phases
	Number of phases.

const unsigned int	_num_components
	Number of fluid components.

const unsigned int	_num_var
	Number of PorousFlow variables.

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 PorousFlowJoinerTempl< is_ad >

Material designed to form a std::vector of property and derivatives of these wrt the nonlinear variables from the individual phase properties.

Values at the quadpoint or the nodes are formed depending on _at_qps

Properties can be viscosities, densities, thermal conductivities , etc and the user specifies the property they are interested in using the pf_prop string.

Also, using d(property)/dP, d(property)/dS, etc, and dP/dvar, dS/dvar, etc, the matrix of derivatives of property with respect to the nonlinear Variables, var, are computed.

Only values at the nodes are used - not at the quadpoints

Definition at line 32 of file PorousFlowJoiner.h.

Constructor & Destructor Documentation

◆ PorousFlowJoinerTempl()

template<bool is_ad>

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

Definition at line 31 of file PorousFlowJoiner.C.

  : PorousFlowMaterialVectorBase(parameters),
    _pf_prop(getParam<std::string>("material_property")),
    _dporepressure_dvar(is_ad              ? nullptr
                        : !_nodal_material ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                 "dPorousFlow_porepressure_qp_dvar")
                                           : &getMaterialProperty<std::vector<std::vector<Real>>>(
                                                 "dPorousFlow_porepressure_nodal_dvar")),
    _dsaturation_dvar(is_ad              ? nullptr
                      : !_nodal_material ? &getMaterialProperty<std::vector<std::vector<Real>>>(
                                               "dPorousFlow_saturation_qp_dvar")
                                         : &getMaterialProperty<std::vector<std::vector<Real>>>(
                                               "dPorousFlow_saturation_nodal_dvar")),
    _dtemperature_dvar(
        is_ad ? nullptr
        : !_nodal_material
            ? &getMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_qp_dvar")
            : &getMaterialProperty<std::vector<Real>>("dPorousFlow_temperature_nodal_dvar")),
    _has_mass_fraction(!_nodal_material
                           ? hasGenericMaterialProperty<std::vector<std::vector<Real>>, is_ad>(
                                 "PorousFlow_mass_frac_qp")
                           : hasGenericMaterialProperty<std::vector<std::vector<Real>>, is_ad>(
                                 "PorousFlow_mass_frac_nodal")),
    _dmass_fraction_dvar(
        is_ad ? nullptr
        : _has_mass_fraction
            ? (!_nodal_material ? &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
                                      "dPorousFlow_mass_frac_qp_dvar")
                                : &getMaterialProperty<std::vector<std::vector<std::vector<Real>>>>(
                                      "dPorousFlow_mass_frac_nodal_dvar"))
            : nullptr),
    _property(declareGenericProperty<std::vector<Real>, is_ad>(_pf_prop)),
    _dproperty_dvar(
        is_ad ? nullptr
              : &declareProperty<std::vector<std::vector<Real>>>("d" + _pf_prop + "_dvar"))
{
  _phase_property.resize(_num_phases);
 
  if (!is_ad)
  {
    _dphase_property_dp.resize(_num_phases);
    _dphase_property_ds.resize(_num_phases);
    _dphase_property_dt.resize(_num_phases);
    _dphase_property_dX.resize(_num_phases);
  }
 
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
  {
    const std::string phase = Moose::stringify(ph);
    _phase_property[ph] = &getGenericMaterialProperty<Real, is_ad>(_pf_prop + phase);
 
    if (!is_ad)
    {
      _dphase_property_dp[ph] =
          &getMaterialPropertyDerivative<Real>(_pf_prop + phase, _pressure_variable_name);
      _dphase_property_ds[ph] =
          &getMaterialPropertyDerivative<Real>(_pf_prop + phase, _saturation_variable_name);
      _dphase_property_dt[ph] =
          &getMaterialPropertyDerivative<Real>(_pf_prop + phase, _temperature_variable_name);
      _dphase_property_dX[ph] =
          &getMaterialPropertyDerivative<Real>(_pf_prop + phase, _mass_fraction_variable_name);
    }
  }
}

Member Function Documentation

◆ computeQpProperties()

template<bool is_ad>

void PorousFlowJoinerTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 108 of file PorousFlowJoiner.C.

{
  initQpStatefulProperties();
 
  if (!is_ad)
  {
    (*_dproperty_dvar)[_qp].resize(_num_phases);
    for (unsigned int ph = 0; ph < _num_phases; ++ph)
    {
      (*_dproperty_dvar)[_qp][ph].resize(_num_var);
      for (unsigned v = 0; v < _num_var; ++v)
      {
        // the "if" conditions in the following are because a nodal_material's derivatives might
        // not have been defined.  If that is the case, then DerivativeMaterial passes back a
        // MaterialProperty with zeroes (for the derivatives), but that property will be sized
        // by the number of quadpoints in the element, which may be smaller than the number of
        // nodes!
        (*_dproperty_dvar)[_qp][ph][v] = 0.0;
        if ((*_dphase_property_dp[ph]).size() > _qp)
          (*_dproperty_dvar)[_qp][ph][v] +=
              (*_dphase_property_dp[ph])[_qp] * (*_dporepressure_dvar)[_qp][ph][v];
        if ((*_dphase_property_ds[ph]).size() > _qp)
          (*_dproperty_dvar)[_qp][ph][v] +=
              (*_dphase_property_ds[ph])[_qp] * (*_dsaturation_dvar)[_qp][ph][v];
        if ((*_dphase_property_dt[ph]).size() > _qp)
          (*_dproperty_dvar)[_qp][ph][v] +=
              (*_dphase_property_dt[ph])[_qp] * (*_dtemperature_dvar)[_qp][v];
 
        // Only add derivative wrt mass fraction if they exist
        if (_has_mass_fraction)
          if ((*_dphase_property_dX[ph]).size() > _qp)
            (*_dproperty_dvar)[_qp][ph][v] +=
                (*_dphase_property_dX[ph])[_qp] * (*_dmass_fraction_dvar)[_qp][ph][0][v];
      }
    }
  }
}

◆ initQpStatefulProperties()

template<bool is_ad>

void PorousFlowJoinerTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Definition at line 98 of file PorousFlowJoiner.C.

{
  _property[_qp].resize(_num_phases);
 
  for (unsigned int ph = 0; ph < _num_phases; ++ph)
    _property[_qp][ph] = (*_phase_property[ph])[_qp];
}

◆ validParams()

template<bool is_ad>

InputParameters PorousFlowJoinerTempl< is_ad >::validParams ( )

static

Definition at line 18 of file PorousFlowJoiner.C.

{
  InputParameters params = PorousFlowMaterialVectorBase::validParams();
  params.addRequiredParam<std::string>("material_property",
                                       "The property that you want joined into a std::vector");
  params.set<std::string>("pf_material_type") = "joiner";
  params.addClassDescription("This Material forms a std::vector of properties, old properties "
                             "(optionally), and derivatives, out of the individual phase "
                             "properties");
  return params;
}

Member Data Documentation

◆ _dmass_fraction_dvar

template<bool is_ad>

const MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowJoinerTempl< is_ad >::_dmass_fraction_dvar

protected

Derivatives of mass fraction variable wrt PorousFlow variables at the qps or nodes.

Definition at line 59 of file PorousFlowJoiner.h.

◆ _dphase_property_dp

template<bool is_ad>

std::vector<const MaterialProperty<Real> *> PorousFlowJoinerTempl< is_ad >::_dphase_property_dp

protected

d(property of each phase)/d(pressure)

Definition at line 71 of file PorousFlowJoiner.h.

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

◆ _dphase_property_ds

template<bool is_ad>

std::vector<const MaterialProperty<Real> *> PorousFlowJoinerTempl< is_ad >::_dphase_property_ds

protected

d(property of each phase)/d(saturation)

Definition at line 74 of file PorousFlowJoiner.h.

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

◆ _dphase_property_dt

template<bool is_ad>

std::vector<const MaterialProperty<Real> *> PorousFlowJoinerTempl< is_ad >::_dphase_property_dt

protected

d(property of each phase)/d(temperature)

Definition at line 77 of file PorousFlowJoiner.h.

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

◆ _dphase_property_dX

template<bool is_ad>

std::vector<const MaterialProperty<Real> *> PorousFlowJoinerTempl< is_ad >::_dphase_property_dX

protected

d(property of each phase)/d(mass fraction)

Definition at line 80 of file PorousFlowJoiner.h.

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

◆ _dporepressure_dvar

template<bool is_ad>

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

protected

Derivatives of porepressure variable wrt PorousFlow variables at the qps or nodes.

Definition at line 47 of file PorousFlowJoiner.h.

◆ _dproperty_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<Real> > >* const PorousFlowJoinerTempl< is_ad >::_dproperty_dvar

protected

d(property)/d(PorousFlow variable)

Definition at line 65 of file PorousFlowJoiner.h.

◆ _dsaturation_dvar

template<bool is_ad>

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

protected

Derivatives of saturation variable wrt PorousFlow variables at the qps or nodes.

Definition at line 50 of file PorousFlowJoiner.h.

◆ _dtemperature_dvar

template<bool is_ad>

const MaterialProperty<std::vector<Real> >* const PorousFlowJoinerTempl< is_ad >::_dtemperature_dvar

protected

Derivatives of temperature variable wrt PorousFlow variables at the qps or nodes.

Definition at line 53 of file PorousFlowJoiner.h.

◆ _has_mass_fraction

template<bool is_ad>

const bool PorousFlowJoinerTempl< is_ad >::_has_mass_fraction

protected

Flag to check whether mass fractions are used.

Definition at line 56 of file PorousFlowJoiner.h.

◆ _num_components

const unsigned int PorousFlowMaterialVectorBase::_num_components

protectedinherited

Number of fluid components.

Definition at line 30 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowAqueousPreDisChemistry::PorousFlowAqueousPreDisChemistry(), PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl(), and PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl().

◆ _num_phases

const unsigned int PorousFlowMaterialVectorBase::_num_phases

protectedinherited

Number of phases.

Definition at line 27 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBaseTempl< is_ad >::PorousFlowDiffusivityBaseTempl(), PorousFlowDiffusivityConstTempl< is_ad >::PorousFlowDiffusivityConstTempl(), PorousFlowJoinerTempl< is_ad >::PorousFlowJoinerTempl(), PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl(), PorousFlowThermalConductivityFromPorosityTempl< is_ad >::PorousFlowThermalConductivityFromPorosityTempl(), PorousFlowThermalConductivityIdealTempl< is_ad >::PorousFlowThermalConductivityIdealTempl(), and PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity().

◆ _num_var

const unsigned int PorousFlowMaterialVectorBase::_num_var

protectedinherited

Number of PorousFlow variables.

Definition at line 33 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowPorosityLinear::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowAqueousPreDisChemistry::initQpStatefulProperties(), and PorousFlowPorosityLinear::initQpStatefulProperties().

◆ _pf_prop

template<bool is_ad>

const std::string PorousFlowJoinerTempl< is_ad >::_pf_prop

protected

Name of material property to be joined.

Definition at line 44 of file PorousFlowJoiner.h.

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

◆ _phase_property

template<bool is_ad>

std::vector<const GenericMaterialProperty<Real, is_ad> *> PorousFlowJoinerTempl< is_ad >::_phase_property

protected

Property of each phase.

Definition at line 68 of file PorousFlowJoiner.h.

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

◆ _property

template<bool is_ad>

GenericMaterialProperty<std::vector<Real>, is_ad>& PorousFlowJoinerTempl< is_ad >::_property

protected

Computed property of the phase.

Definition at line 62 of file PorousFlowJoiner.h.

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

porous_flow/include/materials/PorousFlowJoiner.h
porous_flow/src/materials/PorousFlowJoiner.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

◆ PorousFlowJoinerTempl()

Member Function Documentation

◆ computeQpProperties()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _dmass_fraction_dvar

◆ _dphase_property_dp

◆ _dphase_property_ds

◆ _dphase_property_dt

◆ _dphase_property_dX

◆ _dporepressure_dvar

◆ _dproperty_dvar

◆ _dsaturation_dvar

◆ _dtemperature_dvar

◆ _has_mass_fraction

◆ _num_components

◆ _num_phases

◆ _num_var

◆ _pf_prop

◆ _phase_property

◆ _property