Material designed to form a std::vector<std::vector> of mass fractions from the individual mass fraction variables. More...

#include <PorousFlowMassFraction.h>

Inheritance diagram for PorousFlowMassFractionTempl< is_ad >:

[legend]

Public Types
typedef DerivativeMaterialPropertyNameInterface::SymbolName	SymbolName

Public Member Functions
	PorousFlowMassFractionTempl (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	build_mass_frac (unsigned int qp)
	Builds the mass-fraction variable matrix at the quad point. More...

Protected Attributes
GenericMaterialProperty< std::vector< std::vector< Real > >, is_ad > &	_mass_frac
	Mass fraction matrix at quadpoint or nodes. More...

GenericMaterialProperty< std::vector< std::vector< RealGradient > >, is_ad > *const	_grad_mass_frac
	Gradient of the mass fraction matrix at the quad points. More...

MaterialProperty< std::vector< std::vector< std::vector< Real > > > > *const	_dmass_frac_dvar
	Derivative of the mass fraction matrix with respect to the porous flow variables. More...

const unsigned int	_num_passed_mf_vars
	Number of mass-fraction variables provided by the user This needs to be num_phases(_num_components - 1), since the mass fraction of the final component in each phase is determined as 1 - sum*{components}(mass fraction of all other components in the phase) More...

std::vector< unsigned int >	_mf_vars_num
	The variable number of the mass-fraction variables. More...

std::vector< const GenericVariableValue< is_ad > * >	_mf_vars
	The mass-fraction variables. More...

std::vector< const GenericVariableGradient< is_ad > * >	_grad_mf_vars
	The gradient of the mass-fraction variables. More...

const unsigned int	_num_phases
	Number of phases. More...

const unsigned int	_num_components
	Number of fluid components. More...

const unsigned int	_num_var
	Number of PorousFlow variables. More...

Detailed Description

template<bool is_ad>
class PorousFlowMassFractionTempl< is_ad >

Material designed to form a std::vector<std::vector> of mass fractions from the individual mass fraction variables.

Definition at line 19 of file PorousFlowMassFraction.h.

Constructor & Destructor Documentation

◆ PorousFlowMassFractionTempl()

template<bool is_ad>

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

Definition at line 35 of file PorousFlowMassFraction.C.

   : PorousFlowMaterialVectorBase(parameters),
     _mass_frac(_nodal_material ? declareGenericProperty<std::vector<std::vector<Real>>, is_ad>(
                                      "PorousFlow_mass_frac_nodal")
                                : declareGenericProperty<std::vector<std::vector<Real>>, is_ad>(
                                      "PorousFlow_mass_frac_qp")),
     _grad_mass_frac(_nodal_material
                         ? nullptr
                         : &declareGenericProperty<std::vector<std::vector<RealGradient>>, is_ad>(
                               "PorousFlow_grad_mass_frac_qp")),
     _dmass_frac_dvar(is_ad ? nullptr
                      : _nodal_material
                          ? &declareProperty<std::vector<std::vector<std::vector<Real>>>>(
                                "dPorousFlow_mass_frac_nodal_dvar")
                          : &declareProperty<std::vector<std::vector<std::vector<Real>>>>(
                                "dPorousFlow_mass_frac_qp_dvar")),
     _num_passed_mf_vars(isParamValid("mass_fraction_vars") ? coupledComponents("mass_fraction_vars")
                                                            : 0)
 {
   if (_num_phases < 1 || _num_components < 1)
     mooseError("PorousFlowMassFraction: The Dictator proclaims that the number of phases is ",
                _num_phases,
                " and the number of components is ",
                _num_components,
                ", and stipulates that you should not use PorousFlowMassFraction in this case");
 
   if (_num_passed_mf_vars != _num_phases * (_num_components - 1))
     paramError("mass_fraction_vars",
                "This value must be equal to the Dictator's num_phases (",
                _num_phases,
                ") multiplied by num_components-1 (",
                _num_components - 1,
                ")");
 
   _mf_vars_num.resize(_num_passed_mf_vars);
   _mf_vars.resize(_num_passed_mf_vars);
   _grad_mf_vars.resize(_num_passed_mf_vars);
   for (unsigned i = 0; i < _num_passed_mf_vars; ++i)
   {
     // If mass_fraction_vars are elemental AuxVariables (or constants), we want to use
     // coupledGenericValue() rather than coupledGenericDofValue()
     const bool is_nodal =
         isCoupled("mass_fraction_vars") ? getFieldVar("mass_fraction_vars", i)->isNodal() : false;
 
     _mf_vars_num[i] = coupled("mass_fraction_vars", i);
     _mf_vars[i] =
         (_nodal_material && is_nodal ? &coupledGenericDofValue<is_ad>("mass_fraction_vars", i)
                                      : &coupledGenericValue<is_ad>("mass_fraction_vars", i));
     _grad_mf_vars[i] = &coupledGenericGradient<is_ad>("mass_fraction_vars", i);
   }
 }

Member Function Documentation

◆ build_mass_frac()

template<bool is_ad>

void PorousFlowMassFractionTempl< is_ad >::build_mass_frac ( unsigned int qp )

protected

Builds the mass-fraction variable matrix at the quad point.

Parameters

qp	the quad point

◆ computeQpProperties()

template<bool is_ad>

void PorousFlowMassFractionTempl< is_ad >::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowMassFractionAqueousEquilibriumChemistry.

Definition at line 98 of file PorousFlowMassFraction.C.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties().

 {
   // size all properties correctly
   _mass_frac[_qp].resize(_num_phases);
 
   if (!is_ad)
     (*_dmass_frac_dvar)[_qp].resize(_num_phases);
 
   if (!_nodal_material)
     (*_grad_mass_frac)[_qp].resize(_num_phases);
 
   for (unsigned int ph = 0; ph < _num_phases; ++ph)
   {
     _mass_frac[_qp][ph].resize(_num_components);
 
     if (!is_ad)
     {
       (*_dmass_frac_dvar)[_qp][ph].resize(_num_components);
       for (unsigned int comp = 0; comp < _num_components; ++comp)
         (*_dmass_frac_dvar)[_qp][ph][comp].assign(_num_var, 0.0);
     }
 
     if (!_nodal_material)
       (*_grad_mass_frac)[_qp][ph].resize(_num_components);
   }
 
   // compute the values and derivatives
   unsigned int i = 0;
   for (unsigned int ph = 0; ph < _num_phases; ++ph)
   {
     GenericReal<is_ad> total_mass_frac = 0;
 
     if (!_nodal_material)
       (*_grad_mass_frac)[_qp][ph][_num_components - 1] = 0.0;
 
     for (unsigned int comp = 0; comp < _num_components - 1; ++comp)
     {
       _mass_frac[_qp][ph][comp] = (*_mf_vars[i])[_qp];
       total_mass_frac += _mass_frac[_qp][ph][comp];
 
       if (!_nodal_material)
       {
         (*_grad_mass_frac)[_qp][ph][comp] = (*_grad_mf_vars[i])[_qp];
         (*_grad_mass_frac)[_qp][ph][_num_components - 1] -= (*_grad_mf_vars[i])[_qp];
       }
 
       if (!is_ad && _dictator.isPorousFlowVariable(_mf_vars_num[i]))
       {
         // _mf_vars[i] is a PorousFlow variable
         const unsigned int pf_var_num = _dictator.porousFlowVariableNum(_mf_vars_num[i]);
         (*_dmass_frac_dvar)[_qp][ph][comp][pf_var_num] = 1.0;
         (*_dmass_frac_dvar)[_qp][ph][_num_components - 1][pf_var_num] = -1.0;
       }
       i++;
     }
 
     _mass_frac[_qp][ph][_num_components - 1] = 1.0 - total_mass_frac;
   }
 }

◆ initQpStatefulProperties()

template<bool is_ad>

void PorousFlowMassFractionTempl< is_ad >::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowMassFractionAqueousEquilibriumChemistry.

Definition at line 89 of file PorousFlowMassFraction.C.

 {
   // all we need to do is compute _mass_frac for _nodal_materials
   // but the following avoids code duplication
   computeQpProperties();
 }

◆ validParams()

template<bool is_ad>

InputParameters PorousFlowMassFractionTempl< is_ad >::validParams ( )

static

Definition at line 17 of file PorousFlowMassFraction.C.

 {
   InputParameters params = PorousFlowMaterialVectorBase::validParams();
   params.addCoupledVar(
       "mass_fraction_vars",
       "List of variables that represent the mass fractions.  Format is 'f_ph0^c0 "
       "f_ph0^c1 f_ph0^c2 ... f_ph0^c(N-2) f_ph1^c0 f_ph1^c1 fph1^c2 ... "
       "fph1^c(N-2) ... fphP^c0 f_phP^c1 fphP^c2 ... fphP^c(N-2)' where "
       "N=num_components and P=num_phases, and it is assumed that "
       "f_ph^c(N-1)=1-sum(f_ph^c,{c,0,N-2}) so that f_ph^c(N-1) need not be given.  If no "
       "variables are provided then num_phases=1=num_components.");
   params.addPrivateParam<std::string>("pf_material_type", "mass_fraction");
   params.addClassDescription("This Material forms a std::vector<std::vector ...> of mass-fractions "
                              "out of the individual mass fractions");
   return params;
 }

Member Data Documentation

◆ _dmass_frac_dvar

template<bool is_ad>

MaterialProperty<std::vector<std::vector<std::vector<Real> > > >* const PorousFlowMassFractionTempl< is_ad >::_dmass_frac_dvar

protected

Derivative of the mass fraction matrix with respect to the porous flow variables.

Definition at line 34 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties().

◆ _grad_mass_frac

template<bool is_ad>

GenericMaterialProperty<std::vector<std::vector<RealGradient> >, is_ad>* const PorousFlowMassFractionTempl< is_ad >::_grad_mass_frac

protected

Gradient of the mass fraction matrix at the quad points.

Definition at line 31 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties().

◆ _grad_mf_vars

template<bool is_ad>

std::vector<const GenericVariableGradient<is_ad> *> PorousFlowMassFractionTempl< is_ad >::_grad_mf_vars

protected

The gradient of the mass-fraction variables.

Definition at line 60 of file PorousFlowMassFraction.h.

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

◆ _mass_frac

template<bool is_ad>

GenericMaterialProperty<std::vector<std::vector<Real> >, is_ad>& PorousFlowMassFractionTempl< is_ad >::_mass_frac

protected

Mass fraction matrix at quadpoint or nodes.

Definition at line 28 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties().

◆ _mf_vars

template<bool is_ad>

std::vector<const GenericVariableValue<is_ad> *> PorousFlowMassFractionTempl< is_ad >::_mf_vars

protected

The mass-fraction variables.

Definition at line 57 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpSecondaryConcentrations(), PorousFlowMassFractionAqueousEquilibriumChemistry::dQpSecondaryConcentration_dprimary(), PorousFlowMassFractionAqueousEquilibriumChemistry::findZeroConcentration(), and PorousFlowMassFractionTempl< is_ad >::PorousFlowMassFractionTempl().

◆ _mf_vars_num

template<bool is_ad>

std::vector<unsigned int> PorousFlowMassFractionTempl< is_ad >::_mf_vars_num

protected

The variable number of the mass-fraction variables.

Definition at line 54 of file PorousFlowMassFraction.h.

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

◆ _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_passed_mf_vars

template<bool is_ad>

const unsigned int PorousFlowMassFractionTempl< is_ad >::_num_passed_mf_vars

protected

Number of mass-fraction variables provided by the user This needs to be num_phases*(_num_components - 1), since the mass fraction of the final component in each phase is determined as 1 - sum{components}(mass fraction of all other components in the phase)

Definition at line 51 of file PorousFlowMassFraction.h.

Referenced by 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 PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowPorosityLinear::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), PorousFlowAqueousPreDisChemistry::initQpStatefulProperties(), and PorousFlowPorosityLinear::initQpStatefulProperties().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<bool is_ad> class PorousFlowMassFractionTempl< is_ad >

Constructor & Destructor Documentation

◆ PorousFlowMassFractionTempl()

Member Function Documentation

◆ build_mass_frac()

◆ computeQpProperties()

◆ initQpStatefulProperties()

◆ validParams()

Member Data Documentation

◆ _dmass_frac_dvar

◆ _grad_mass_frac

◆ _grad_mf_vars

◆ _mass_frac

◆ _mf_vars

◆ _mf_vars_num

◆ _num_components

◆ _num_passed_mf_vars

◆ _num_phases

◆ _num_var

template<bool is_ad>
class PorousFlowMassFractionTempl< is_ad >