Provides a simple interface to PorousFlow material properties. More...

#include <PorousFlowPropertyAux.h>

Inheritance diagram for PorousFlowPropertyAux:

Public Member Functions
	PorousFlowPropertyAux (const InputParameters &parameters)

Protected Member Functions
virtual Real	computeValue () override

Private Types
enum	PropertyEnum { PropertyEnum::PRESSURE, PropertyEnum::SATURATION, PropertyEnum::TEMPERATURE, PropertyEnum::DENSITY, PropertyEnum::VISCOSITY, PropertyEnum::MASS_FRACTION, PropertyEnum::RELPERM, PropertyEnum::CAPILLARY_PRESSURE, PropertyEnum::ENTHALPY, PropertyEnum::INTERNAL_ENERGY, PropertyEnum::SECONDARY_CONCENTRATION, PropertyEnum::MINERAL_CONCENTRATION, PropertyEnum::MINERAL_REACTION_RATE, PropertyEnum::POROSITY, PropertyEnum::PERMEABILITY }
	Enum of properties. More...

Private Attributes
const MaterialProperty< std::vector< Real > > *	_pressure
	Pressure of each phase. More...

const MaterialProperty< std::vector< Real > > *	_saturation
	Saturation of each phase. More...

const MaterialProperty< Real > *	_temperature
	Temperature of the fluid. More...

const MaterialProperty< std::vector< Real > > *	_fluid_density
	Fluid density of each phase. More...

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

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

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

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

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

const MaterialProperty< std::vector< Real > > *	_sec_conc
	Secondary-species concentration. More...

const MaterialProperty< std::vector< Real > > *	_mineral_conc
	Mineral-species concentration. More...

const MaterialProperty< std::vector< Real > > *	_mineral_reaction_rate
	Mineral-species reacion rate. More...

const MaterialProperty< Real > *	_porosity
	Porosity of the media. More...

const MaterialProperty< RealTensorValue > *	_permeability
	Permeability of the media. More...

const PorousFlowDictator &	_dictator
	PorousFlowDictator UserObject. More...

enum PorousFlowPropertyAux::PropertyEnum	_property_enum

const unsigned int	_phase
	Phase index. More...

const unsigned int	_liquid_phase
	Liquid phase index. More...

const unsigned int	_gas_phase
	Gas phase index. More...

const unsigned int	_fluid_component
	Fluid component index. More...

const unsigned int	_secondary_species
	Secondary species number. More...

const unsigned int	_mineral_species
	Mineral species number. More...

const unsigned int	_k_row
	Permeability tensor row and column. More...

const unsigned int	_k_col

Detailed Description

Provides a simple interface to PorousFlow material properties.

Note that as all properties are in materials, only elemental AuxVariables can be used and as such, all properties are evaluated at the qps only

Definition at line 26 of file PorousFlowPropertyAux.h.

Member Enumeration Documentation

◆ PropertyEnum

enum PorousFlowPropertyAux::PropertyEnum

strongprivate

Enum of properties.

Enumerator
PRESSURE
SATURATION
TEMPERATURE
DENSITY
VISCOSITY
MASS_FRACTION
RELPERM
CAPILLARY_PRESSURE
ENTHALPY
INTERNAL_ENERGY
SECONDARY_CONCENTRATION
MINERAL_CONCENTRATION
MINERAL_REACTION_RATE
POROSITY
PERMEABILITY

Definition at line 81 of file PorousFlowPropertyAux.h.

                                 {
     PRESSURE,
     SATURATION,
     TEMPERATURE,
     DENSITY,
     VISCOSITY,
     MASS_FRACTION,
     RELPERM,
     CAPILLARY_PRESSURE,
     ENTHALPY,
     INTERNAL_ENERGY,
     SECONDARY_CONCENTRATION,
     MINERAL_CONCENTRATION,
     MINERAL_REACTION_RATE,
     POROSITY,
     PERMEABILITY
   } _property_enum;

Constructor & Destructor Documentation

◆ PorousFlowPropertyAux()

PorousFlowPropertyAux::PorousFlowPropertyAux ( const InputParameters & parameters )

Definition at line 45 of file PorousFlowPropertyAux.C.

   : AuxKernel(parameters),
     _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
     _property_enum(getParam<MooseEnum>("property").getEnum<PropertyEnum>()),
     _phase(getParam<unsigned int>("phase")),
     _liquid_phase(getParam<unsigned int>("liquid_phase")),
     _gas_phase(getParam<unsigned int>("gas_phase")),
     _fluid_component(getParam<unsigned int>("fluid_component")),
     _secondary_species(getParam<unsigned int>("secondary_species")),
     _mineral_species(getParam<unsigned int>("mineral_species")),
     _k_row(getParam<unsigned int>("row")),
     _k_col(getParam<unsigned int>("column"))
 {
   // Check that the phase and fluid_component are valid
   if (_phase >= _dictator.numPhases())
     paramError("phase",
                "Phase number entered is greater than the number of phases specified in the "
                "Dictator. Remember that indexing starts at 0");
  
   if (_fluid_component >= _dictator.numComponents())
     paramError("fluid_component",
                "Fluid component number entered is greater than the number of fluid components "
                "specified in the Dictator. Remember that indexing starts at 0");
  
   // Check the parameters used to calculate capillary pressure
   if (_property_enum == PropertyEnum::CAPILLARY_PRESSURE)
   {
     if (_liquid_phase >= _dictator.numPhases())
       paramError(
           "liquid_phase",
           "Liquid phase number entered is greater than the number of phases specified in the "
           "Dictator. Remember that indexing starts at 0");
  
     if (_gas_phase >= _dictator.numPhases())
       paramError("gas_phase",
                  "Gas phase number entered is greater than the number of phases specified in the "
                  "Dictator. Remember that indexing starts at 0");
  
     if (_liquid_phase == _gas_phase)
       paramError("liquid_phase", "Liquid phase number entered cannot be equal to gas_phase");
   }
  
   if (_property_enum == PropertyEnum::SECONDARY_CONCENTRATION &&
       (_secondary_species >= _dictator.numAqueousEquilibrium()))
     paramError("secondary_species",
                "Secondary species number entered is greater than the number of aqueous equilibrium "
                "chemical reactions specified in the Dictator. Remember that indexing starts at 0");
  
   if ((_property_enum == PropertyEnum::MINERAL_CONCENTRATION ||
        _property_enum == PropertyEnum::MINERAL_REACTION_RATE) &&
       (_mineral_species >= _dictator.numAqueousKinetic()))
     paramError("mineral_species",
                "Mineral species number entered is greater than the number of aqueous "
                "precipitation-dissolution chemical reactions specified in the Dictator. Remember "
                "that indexing starts at 0");
  
   // Only get material properties required by this instance of the AuxKernel
   switch (_property_enum)
   {
     case PropertyEnum::PRESSURE:
       _pressure = &getMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp");
       break;
  
     case PropertyEnum::SATURATION:
       _saturation = &getMaterialProperty<std::vector<Real>>("PorousFlow_saturation_qp");
       break;
  
     case PropertyEnum::TEMPERATURE:
       _temperature = &getMaterialProperty<Real>("PorousFlow_temperature_qp");
       break;
  
     case PropertyEnum::DENSITY:
       _fluid_density = &getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_qp");
       break;
  
     case PropertyEnum::VISCOSITY:
       _fluid_viscosity = &getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_qp");
       break;
  
     case PropertyEnum::MASS_FRACTION:
       _mass_fractions =
           &getMaterialProperty<std::vector<std::vector<Real>>>("PorousFlow_mass_frac_qp");
       break;
  
     case PropertyEnum::RELPERM:
       _relative_permeability =
           &getMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_qp");
       break;
  
     case PropertyEnum::CAPILLARY_PRESSURE:
       _pressure = &getMaterialProperty<std::vector<Real>>("PorousFlow_porepressure_qp");
       break;
  
     case PropertyEnum::ENTHALPY:
       _enthalpy = &getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_enthalpy_qp");
       break;
  
     case PropertyEnum::INTERNAL_ENERGY:
       _internal_energy =
           &getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_internal_energy_qp");
       break;
  
     case PropertyEnum::SECONDARY_CONCENTRATION:
       _sec_conc = &getMaterialProperty<std::vector<Real>>("PorousFlow_secondary_concentration_qp");
       break;
  
     case PropertyEnum::MINERAL_CONCENTRATION:
       _mineral_conc =
           &getMaterialProperty<std::vector<Real>>("PorousFlow_mineral_concentration_qp");
       break;
  
     case PropertyEnum::MINERAL_REACTION_RATE:
       _mineral_reaction_rate =
           &getMaterialProperty<std::vector<Real>>("PorousFlow_mineral_reaction_rate_qp");
       break;
  
     case PropertyEnum::POROSITY:
       _porosity = &getMaterialProperty<Real>("PorousFlow_porosity_qp");
       break;
  
     case PropertyEnum::PERMEABILITY:
       _permeability = &getMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp");
       break;
   }
 }

Member Function Documentation

◆ computeValue()

Real PorousFlowPropertyAux::computeValue ( )

overrideprotectedvirtual

Definition at line 172 of file PorousFlowPropertyAux.C.

 {
   Real property = 0.0;
  
   switch (_property_enum)
   {
     case PropertyEnum::PRESSURE:
       property = (*_pressure)[_qp][_phase];
       break;
  
     case PropertyEnum::SATURATION:
       property = (*_saturation)[_qp][_phase];
       break;
  
     case PropertyEnum::TEMPERATURE:
       property = (*_temperature)[_qp];
       break;
  
     case PropertyEnum::DENSITY:
       property = (*_fluid_density)[_qp][_phase];
       break;
  
     case PropertyEnum::VISCOSITY:
       property = (*_fluid_viscosity)[_qp][_phase];
       break;
  
     case PropertyEnum::MASS_FRACTION:
       property = (*_mass_fractions)[_qp][_phase][_fluid_component];
       break;
  
     case PropertyEnum::RELPERM:
       property = (*_relative_permeability)[_qp][_phase];
       break;
  
     case PropertyEnum::CAPILLARY_PRESSURE:
       property = (*_pressure)[_qp][_gas_phase] - (*_pressure)[_qp][_liquid_phase];
       break;
  
     case PropertyEnum::ENTHALPY:
       property = (*_enthalpy)[_qp][_phase];
       break;
  
     case PropertyEnum::INTERNAL_ENERGY:
       property = (*_internal_energy)[_qp][_phase];
       break;
  
     case PropertyEnum::SECONDARY_CONCENTRATION:
       property = (*_sec_conc)[_qp][_secondary_species];
       break;
  
     case PropertyEnum::MINERAL_CONCENTRATION:
       property = (*_mineral_conc)[_qp][_mineral_species];
       break;
  
     case PropertyEnum::MINERAL_REACTION_RATE:
       property = (*_mineral_reaction_rate)[_qp][_mineral_species];
       break;
  
     case PropertyEnum::POROSITY:
       property = (*_porosity)[_qp];
       break;
  
     case PropertyEnum::PERMEABILITY:
       property = (*_permeability)[_qp](_k_row, _k_col);
       break;
   }
  
   return property;
 }

Member Data Documentation

◆ _dictator

const PorousFlowDictator& PorousFlowPropertyAux::_dictator

private

PorousFlowDictator UserObject.

Definition at line 78 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _enthalpy

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

private

Enthalpy of each phase.

Definition at line 57 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _fluid_component

const unsigned int PorousFlowPropertyAux::_fluid_component

private

Fluid component index.

Definition at line 109 of file PorousFlowPropertyAux.h.

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _fluid_density

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

private

Fluid density of each phase.

Definition at line 45 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _fluid_viscosity

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

private

Viscosity of each phase.

Definition at line 48 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _gas_phase

const unsigned int PorousFlowPropertyAux::_gas_phase

private

Gas phase index.

Definition at line 106 of file PorousFlowPropertyAux.h.

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _internal_energy

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

private

Internal energy of each phase.

Definition at line 60 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _k_col

const unsigned int PorousFlowPropertyAux::_k_col

private

Definition at line 119 of file PorousFlowPropertyAux.h.

Referenced by computeValue().

◆ _k_row

const unsigned int PorousFlowPropertyAux::_k_row

private

Permeability tensor row and column.

Definition at line 118 of file PorousFlowPropertyAux.h.

Referenced by computeValue().

◆ _liquid_phase

const unsigned int PorousFlowPropertyAux::_liquid_phase

private

Liquid phase index.

Definition at line 103 of file PorousFlowPropertyAux.h.

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _mass_fractions

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

private

Mass fraction of each component in each phase.

Definition at line 51 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _mineral_conc

const MaterialProperty<std::vector<Real> >* PorousFlowPropertyAux::_mineral_conc

private

Mineral-species concentration.

Definition at line 66 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _mineral_reaction_rate

const MaterialProperty<std::vector<Real> >* PorousFlowPropertyAux::_mineral_reaction_rate

private

Mineral-species reacion rate.

Definition at line 69 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _mineral_species

const unsigned int PorousFlowPropertyAux::_mineral_species

private

Mineral species number.

Definition at line 115 of file PorousFlowPropertyAux.h.

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _permeability

const MaterialProperty<RealTensorValue>* PorousFlowPropertyAux::_permeability

private

Permeability of the media.

Definition at line 75 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _phase

const unsigned int PorousFlowPropertyAux::_phase

private

Phase index.

Definition at line 100 of file PorousFlowPropertyAux.h.

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _porosity

const MaterialProperty<Real>* PorousFlowPropertyAux::_porosity

private

Porosity of the media.

Definition at line 72 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _pressure

const MaterialProperty<std::vector<Real> >* PorousFlowPropertyAux::_pressure

private

Pressure of each phase.

Definition at line 36 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _property_enum

enum PorousFlowPropertyAux::PropertyEnum PorousFlowPropertyAux::_property_enum

private

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _relative_permeability

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

private

Relative permeability of each phase.

Definition at line 54 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _saturation

const MaterialProperty<std::vector<Real> >* PorousFlowPropertyAux::_saturation

private

Saturation of each phase.

Definition at line 39 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _sec_conc

const MaterialProperty<std::vector<Real> >* PorousFlowPropertyAux::_sec_conc

private

Secondary-species concentration.

Definition at line 63 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

◆ _secondary_species

const unsigned int PorousFlowPropertyAux::_secondary_species

private

Secondary species number.

Definition at line 112 of file PorousFlowPropertyAux.h.

Referenced by computeValue(), and PorousFlowPropertyAux().

◆ _temperature

const MaterialProperty<Real>* PorousFlowPropertyAux::_temperature

private

Temperature of the fluid.

Definition at line 42 of file PorousFlowPropertyAux.h.

Referenced by PorousFlowPropertyAux().

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

porous_flow/include/auxkernels/PorousFlowPropertyAux.h
porous_flow/src/auxkernels/PorousFlowPropertyAux.C

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ PropertyEnum

Constructor & Destructor Documentation

◆ PorousFlowPropertyAux()

Member Function Documentation

◆ computeValue()

Member Data Documentation

◆ _dictator

◆ _enthalpy

◆ _fluid_component

◆ _fluid_density

◆ _fluid_viscosity

◆ _gas_phase

◆ _internal_energy

◆ _k_col

◆ _k_row

◆ _liquid_phase

◆ _mass_fractions

◆ _mineral_conc

◆ _mineral_reaction_rate

◆ _mineral_species

◆ _permeability

◆ _phase

◆ _porosity

◆ _pressure

◆ _property_enum

◆ _relative_permeability

◆ _saturation

◆ _sec_conc

◆ _secondary_species

◆ _temperature