PorousFlowMassFraction Class Reference

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 PorousFlowMassFraction:

Public Member Functions
	PorousFlowMassFraction (const InputParameters &parameters)

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
MaterialProperty< std::vector< std::vector< Real > > > &	_mass_frac
	Mass fraction matrix at quadpoint or nodes. More...
MaterialProperty< std::vector< std::vector< RealGradient > > > *const	_grad_mass_frac
	Gradient of the mass fraction matrix at the quad points. More...
MaterialProperty< std::vector< std::vector< std::vector< Real > > > > &	_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 VariableValue * >	_mf_vars
	The mass-fraction variables. More...
std::vector< const VariableGradient * >	_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

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

Definition at line 23 of file PorousFlowMassFraction.h.

Constructor & Destructor Documentation

PorousFlowMassFraction()

PorousFlowMassFraction::PorousFlowMassFraction

(

const InputParameters &

parameters

)

Definition at line 32 of file PorousFlowMassFraction.C.

  : PorousFlowMaterialVectorBase(parameters),
 
    _mass_frac(_nodal_material
                   ? declareProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_nodal")
                   : declareProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_qp")),
    _grad_mass_frac(_nodal_material ? nullptr
                                    : &declareProperty<std::vector<std::vector<RealGradient>>>(
                                          "PorousFlow_grad_mass_frac_qp")),
    _dmass_frac_dvar(_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(coupledComponents("mass_fraction_vars"))
{
  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)
  {
    _mf_vars_num[i] = coupled("mass_fraction_vars", i);
    _mf_vars[i] = (_nodal_material ? &coupledDofValues("mass_fraction_vars", i)
                                   : &coupledValue("mass_fraction_vars", i));
    _grad_mf_vars[i] = &coupledGradient("mass_fraction_vars", i);
  }
}

Member Function Documentation

build_mass_frac()

void PorousFlowMassFraction::build_mass_frac ( unsigned int  qp )

protected

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

Parameters

qp	the quad point

computeQpProperties()

void PorousFlowMassFraction::computeQpProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowMassFractionAqueousEquilibriumChemistry.

Definition at line 84 of file PorousFlowMassFraction.C.

{
  // size all properties correctly
  _mass_frac[_qp].resize(_num_phases);
  _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);
    _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)
  {
    Real 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 (_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;
  }
}

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), and initQpStatefulProperties().

initQpStatefulProperties()

void PorousFlowMassFraction::initQpStatefulProperties ( )

overrideprotectedvirtual

Reimplemented in PorousFlowMassFractionAqueousEquilibriumChemistry.

Definition at line 76 of file PorousFlowMassFraction.C.

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

Member Data Documentation

_dmass_frac_dvar

MaterialProperty<std::vector<std::vector<std::vector<Real> > > >& PorousFlowMassFraction::_dmass_frac_dvar

protected

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

Definition at line 36 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), and computeQpProperties().

_grad_mass_frac

MaterialProperty<std::vector<std::vector<RealGradient> > >* const PorousFlowMassFraction::_grad_mass_frac

protected

Gradient of the mass fraction matrix at the quad points.

Definition at line 33 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties().

_grad_mf_vars

std::vector<const VariableGradient *> PorousFlowMassFraction::_grad_mf_vars

protected

The gradient of the mass-fraction variables.

Definition at line 62 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), computeQpProperties(), and PorousFlowMassFraction().

_mass_frac

MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowMassFraction::_mass_frac

protected

Mass fraction matrix at quadpoint or nodes.

Definition at line 30 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), and computeQpProperties().

_mf_vars

std::vector<const VariableValue *> PorousFlowMassFraction::_mf_vars

protected

The mass-fraction variables.

Definition at line 59 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpSecondaryConcentrations(), PorousFlowMassFractionAqueousEquilibriumChemistry::dQpSecondaryConcentration_dprimary(), PorousFlowMassFractionAqueousEquilibriumChemistry::findZeroConcentration(), and PorousFlowMassFraction().

_mf_vars_num

std::vector<unsigned int> PorousFlowMassFraction::_mf_vars_num

protected

The variable number of the mass-fraction variables.

Definition at line 56 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), computeQpProperties(), and PorousFlowMassFraction().

_num_components

const unsigned int PorousFlowMaterialVectorBase::_num_components

protectedinherited

Number of fluid components.

Definition at line 33 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBase::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), computeQpProperties(), PorousFlowAqueousPreDisChemistry::PorousFlowAqueousPreDisChemistry(), PorousFlowDiffusivityBase::PorousFlowDiffusivityBase(), and PorousFlowMassFraction().

_num_passed_mf_vars

const unsigned int PorousFlowMassFraction::_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 53 of file PorousFlowMassFraction.h.

Referenced by PorousFlowMassFraction().

_num_phases

const unsigned int PorousFlowMaterialVectorBase::_num_phases

protectedinherited

Number of phases.

Definition at line 30 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBase::computeQpProperties(), PorousFlowDiffusivityMillingtonQuirk::computeQpProperties(), PorousFlowEffectiveFluidPressure::computeQpProperties(), computeQpProperties(), PorousFlowJoiner::computeQpProperties(), PorousFlowEffectiveFluidPressure::initQpStatefulProperties(), PorousFlowJoiner::initQpStatefulProperties(), PorousFlowDiffusivityBase::PorousFlowDiffusivityBase(), PorousFlowDiffusivityConst::PorousFlowDiffusivityConst(), PorousFlowJoiner::PorousFlowJoiner(), PorousFlowMassFraction(), PorousFlowThermalConductivityFromPorosity::PorousFlowThermalConductivityFromPorosity(), PorousFlowThermalConductivityIdeal::PorousFlowThermalConductivityIdeal(), and PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity().

_num_var

const unsigned int PorousFlowMaterialVectorBase::_num_var

protectedinherited

Number of PorousFlow variables.

Definition at line 36 of file PorousFlowMaterialVectorBase.h.

Referenced by PorousFlowDiffusivityBase::computeQpProperties(), PorousFlowPermeabilityConst::computeQpProperties(), PorousFlowVolumetricStrain::computeQpProperties(), PorousFlowDiffusivityMillingtonQuirk::computeQpProperties(), PorousFlowAqueousPreDisChemistry::computeQpProperties(), PorousFlowPermeabilityTensorFromVar::computeQpProperties(), PorousFlowPorosityConst::computeQpProperties(), PorousFlowMassFractionAqueousEquilibriumChemistry::computeQpProperties(), PorousFlowThermalConductivityIdeal::computeQpProperties(), PorousFlowEffectiveFluidPressure::computeQpProperties(), PorousFlowThermalConductivityFromPorosity::computeQpProperties(), PorousFlowMatrixInternalEnergy::computeQpProperties(), PorousFlowPorosityHMBiotModulus::computeQpProperties(), PorousFlowTotalGravitationalDensityFullySaturatedFromPorosity::computeQpProperties(), PorousFlowPermeabilityConstFromVar::computeQpProperties(), PorousFlowPermeabilityExponential::computeQpProperties(), computeQpProperties(), PorousFlowPermeabilityKozenyCarman::computeQpProperties(), PorousFlowJoiner::computeQpProperties(), PorousFlowPorosityExponentialBase::computeQpProperties(), and PorousFlowAqueousPreDisChemistry::initQpStatefulProperties().

---

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

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