Material to calculate the Darcy velocity for all phases. More...

#include <PorousFlowDarcyVelocityMaterial.h>

Inheritance diagram for PorousFlowDarcyVelocityMaterial:

Public Member Functions
	PorousFlowDarcyVelocityMaterial (const InputParameters &parameters)

virtual void	initialSetup () override

Protected Member Functions
virtual void	computeQpProperties () override

virtual void	initStatefulProperties (unsigned int n_points) override
	Correctly sizes nodal materials, then initialises using Material::initStatefulProperties. More...

virtual void	computeProperties () override
	Correctly sizes nodal materials, then computes using Material::computeProperties. More...

void	sizeNodalProperties ()
	Resizes properties to be equal to max(number of nodes, number of quadpoints) in the current element. More...

unsigned	nearestQP (unsigned nodenum) const
	Find the nearest quadpoint to the node labelled by nodenum in the current element. More...

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

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

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

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

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

const MaterialProperty< std::vector< Real > > &	_fluid_density
	Fluid density for each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dfluid_density_dvar
	Derivative of the fluid density for each phase wrt PorousFlow variables. More...

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

const MaterialProperty< std::vector< std::vector< Real > > > &	_dfluid_viscosity_dvar
	Derivative of the fluid viscosity for each phase wrt PorousFlow variables. More...

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

const MaterialProperty< std::vector< std::vector< Real > > > &	_drelative_permeability_dvar
	Derivative of relative permeability of each phase wrt PorousFlow variables. More...

const MaterialProperty< std::vector< RealGradient > > &	_grad_p
	Gradient of the pore pressure in each phase. More...

const MaterialProperty< std::vector< std::vector< Real > > > &	_dgrad_p_dgradvar
	Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables) More...

const MaterialProperty< std::vector< std::vector< RealGradient > > > &	_dgrad_p_dvar
	Derivative of Grad porepressure in each phase wrt PorousFlow variables. More...

const RealVectorValue	_gravity
	Gravity. More...

MaterialProperty< std::vector< RealVectorValue > > &	_darcy_velocity
	Computed Darcy velocity of each phase. More...

MaterialProperty< std::vector< std::vector< RealVectorValue > > > &	_ddarcy_velocity_dvar
	_ddarcy_velocity_dvar[_qp][ph][v](i) = d(i_th component of velocity of phase ph at quadpoint _qp)/d(PorousFlow variable v) More...

MaterialProperty< std::vector< std::vector< std::vector< RealVectorValue > > > > &	_ddarcy_velocity_dgradvar
	_ddarcy_velocity_dgradvar[_qp][ph][j][v](i) = d(i_th component of Darcy velocity of phase ph at quadpoint _qp) / d(j_th component of grad(PorousFlow variable v)) In an advection Kernel, grad_test * _darcy_velocity[ph] * u, the contribution to the Jacobian is grad_test * (_ddarcy_velocity_dgradvar[_qp][ph][j][v] * _grad_phi[_j][_qp](j)) * u More...

const bool	_nodal_material
	Whether the derived class holds nodal values. More...

const PorousFlowDictator &	_dictator
	The variable names UserObject for the PorousFlow variables. More...

const VariableName	_pressure_variable_name
	Names of variables used to declare/get derivatives in the DerivativeMaterialInterface to ensure consistency. More...

const VariableName	_saturation_variable_name

const VariableName	_temperature_variable_name

const VariableName	_mass_fraction_variable_name

Detailed Description

Material to calculate the Darcy velocity for all phases.

Definition at line 22 of file PorousFlowDarcyVelocityMaterial.h.

Constructor & Destructor Documentation

◆ PorousFlowDarcyVelocityMaterial()

PorousFlowDarcyVelocityMaterial::PorousFlowDarcyVelocityMaterial ( const InputParameters & parameters )

Definition at line 27 of file PorousFlowDarcyVelocityMaterial.C.

   : PorousFlowMaterial(parameters),
     _num_phases(_dictator.numPhases()),
     _num_var(_dictator.numVariables()),
     _permeability(getMaterialProperty<RealTensorValue>("PorousFlow_permeability_qp")),
     _dpermeability_dvar(
         getMaterialProperty<std::vector<RealTensorValue>>("dPorousFlow_permeability_qp_dvar")),
     _dpermeability_dgradvar(getMaterialProperty<std::vector<std::vector<RealTensorValue>>>(
         "dPorousFlow_permeability_qp_dgradvar")),
     _fluid_density(getMaterialProperty<std::vector<Real>>("PorousFlow_fluid_phase_density_qp")),
     _dfluid_density_dvar(getMaterialProperty<std::vector<std::vector<Real>>>(
         "dPorousFlow_fluid_phase_density_qp_dvar")),
     _fluid_viscosity(getMaterialProperty<std::vector<Real>>("PorousFlow_viscosity_qp")),
     _dfluid_viscosity_dvar(
         getMaterialProperty<std::vector<std::vector<Real>>>("dPorousFlow_viscosity_qp_dvar")),
     _relative_permeability(
         getMaterialProperty<std::vector<Real>>("PorousFlow_relative_permeability_qp")),
     _drelative_permeability_dvar(getMaterialProperty<std::vector<std::vector<Real>>>(
         "dPorousFlow_relative_permeability_qp_dvar")),
     _grad_p(getMaterialProperty<std::vector<RealGradient>>("PorousFlow_grad_porepressure_qp")),
     _dgrad_p_dgradvar(getMaterialProperty<std::vector<std::vector<Real>>>(
         "dPorousFlow_grad_porepressure_qp_dgradvar")),
     _dgrad_p_dvar(getMaterialProperty<std::vector<std::vector<RealGradient>>>(
         "dPorousFlow_grad_porepressure_qp_dvar")),
     _gravity(getParam<RealVectorValue>("gravity")),
     _darcy_velocity(declareProperty<std::vector<RealVectorValue>>("PorousFlow_darcy_velocity_qp")),
     _ddarcy_velocity_dvar(declareProperty<std::vector<std::vector<RealVectorValue>>>(
         "dPorousFlow_darcy_velocity_qp_dvar")),
     _ddarcy_velocity_dgradvar(
         declareProperty<std::vector<std::vector<std::vector<RealVectorValue>>>>(
             "dPorousFlow_darcy_velocity_qp_dgradvar"))
 {
   if (_nodal_material == true)
     mooseError("PorousFlowDarcyVelocityMaterial is only defined for at_nodes = false");
 }

Member Function Documentation

◆ computeProperties()

void PorousFlowMaterial::computeProperties ( )

overrideprotectedvirtualinherited

Correctly sizes nodal materials, then computes using Material::computeProperties.

Definition at line 63 of file PorousFlowMaterial.C.

 {
   if (_nodal_material)
   {
     // size the properties to max(number_of_nodes, number_of_quadpoints)
     sizeNodalProperties();
  
     // compute the values for number_of_nodes
     for (_qp = 0; _qp < _current_elem->n_nodes(); ++_qp)
       computeQpProperties();
   }
   else
     Material::computeProperties();
 }

◆ computeQpProperties()

void PorousFlowDarcyVelocityMaterial::computeQpProperties ( )

overrideprotectedvirtual

Definition at line 64 of file PorousFlowDarcyVelocityMaterial.C.

 {
   _darcy_velocity[_qp].resize(_num_phases);
  
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     _darcy_velocity[_qp][ph] =
         -(_permeability[_qp] * (_grad_p[_qp][ph] - _fluid_density[_qp][ph] * _gravity) *
           _relative_permeability[_qp][ph] / _fluid_viscosity[_qp][ph]);
  
   _ddarcy_velocity_dvar[_qp].resize(_num_phases);
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     _ddarcy_velocity_dvar[_qp][ph].resize(_num_var);
  
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     for (unsigned v = 0; v < _num_var; ++v)
     {
       _ddarcy_velocity_dvar[_qp][ph][v] =
           -_dpermeability_dvar[_qp][v] * (_grad_p[_qp][ph] - _fluid_density[_qp][ph] * _gravity) *
           _relative_permeability[_qp][ph] / _fluid_viscosity[_qp][ph];
       _ddarcy_velocity_dvar[_qp][ph][v] -=
           _permeability[_qp] *
           (_dgrad_p_dvar[_qp][ph][v] - _dfluid_density_dvar[_qp][ph][v] * _gravity) *
           _relative_permeability[_qp][ph] / _fluid_viscosity[_qp][ph];
       _ddarcy_velocity_dvar[_qp][ph][v] -=
           _permeability[_qp] * (_grad_p[_qp][ph] - _fluid_density[_qp][ph] * _gravity) *
           (_drelative_permeability_dvar[_qp][ph][v] / _fluid_viscosity[_qp][ph] -
            _relative_permeability[_qp][ph] * _dfluid_viscosity_dvar[_qp][ph][v] /
                std::pow(_fluid_viscosity[_qp][ph], 2));
     }
  
   _ddarcy_velocity_dgradvar[_qp].resize(_num_phases);
   for (unsigned ph = 0; ph < _num_phases; ++ph)
   {
     _ddarcy_velocity_dgradvar[_qp][ph].resize(LIBMESH_DIM);
     for (unsigned i = 0; i < LIBMESH_DIM; ++i)
       _ddarcy_velocity_dgradvar[_qp][ph][i].resize(_num_var);
   }
  
   for (unsigned ph = 0; ph < _num_phases; ++ph)
     for (unsigned i = 0; i < LIBMESH_DIM; ++i)
       for (unsigned v = 0; v < _num_var; ++v)
       {
         _ddarcy_velocity_dgradvar[_qp][ph][i][v] =
             -_dpermeability_dgradvar[_qp][i][v] *
             (_grad_p[_qp][ph] - _fluid_density[_qp][ph] * _gravity);
         for (unsigned j = 0; j < LIBMESH_DIM; ++j)
           _ddarcy_velocity_dgradvar[_qp][ph][i][v](j) -=
               _permeability[_qp](j, i) * _dgrad_p_dgradvar[_qp][ph][v];
         _ddarcy_velocity_dgradvar[_qp][ph][i][v] *=
             _relative_permeability[_qp][ph] / _fluid_viscosity[_qp][ph];
       }
 }

◆ initialSetup()

void PorousFlowMaterial::initialSetup ( )

overridevirtualinherited

Definition at line 41 of file PorousFlowMaterial.C.

 {
   if (_nodal_material)
     _material_data->onlyResizeIfSmaller(true);
 }

◆ initStatefulProperties()

void PorousFlowMaterial::initStatefulProperties ( unsigned int n_points )

overrideprotectedvirtualinherited

Correctly sizes nodal materials, then initialises using Material::initStatefulProperties.

Definition at line 48 of file PorousFlowMaterial.C.

 {
   if (_nodal_material)
   {
     // size the properties to max(number_of_nodes, number_of_quadpoints)
     sizeNodalProperties();
  
     // compute the values for number_of_nodes
     Material::initStatefulProperties(_current_elem->n_nodes());
   }
   else
     Material::initStatefulProperties(n_points);
 }

◆ nearestQP()

unsigned PorousFlowMaterial::nearestQP ( unsigned nodenum ) const

protectedinherited

Find the nearest quadpoint to the node labelled by nodenum in the current element.

Parameters

nodenum the node number in the current element

Returns: the nearest quadpoint

Definition at line 98 of file PorousFlowMaterial.C.

 {
   unsigned nearest_qp = 0;
   Real smallest_dist = std::numeric_limits<Real>::max();
   for (unsigned qp = 1; qp < _qrule->n_points(); ++qp)
   {
     const Real this_dist = (_current_elem->point(nodenum) - _q_point[qp]).norm();
     if (this_dist < smallest_dist)
     {
       nearest_qp = qp;
       smallest_dist = this_dist;
     }
   }
   return nearest_qp;
 }

Referenced by PorousFlowNearestQp::computeQpProperties().

◆ sizeNodalProperties()

void PorousFlowMaterial::sizeNodalProperties ( )

protectedinherited

Resizes properties to be equal to max(number of nodes, number of quadpoints) in the current element.

Definition at line 79 of file PorousFlowMaterial.C.

 {
   /*
    * For nodal materials, the Properties should be sized as the maximum of
    * the number of nodes and the number of quadpoints.
    * We only actually need "number of nodes" pieces of information, which are
    * computed by computeProperties(), so the n_points - _current_elem->n_nodes()
    * elements at the end of the std::vector will always be zero, but they
    * are needed because MOOSE does copy operations (etc) that assumes that
    * the std::vector is sized to number of quadpoints.
    *
    * On boundary materials, the number of nodes may be larger than the number of
    * qps on the face of the element, in which case the remaining entries in the
    * material properties storage will be zero.
    */
   _material_data->resize(std::max(_current_elem->n_nodes(), _qrule->n_points()));
 }

Referenced by PorousFlowMaterial::computeProperties(), and PorousFlowMaterial::initStatefulProperties().

Member Data Documentation

◆ _darcy_velocity

MaterialProperty<std::vector<RealVectorValue> >& PorousFlowDarcyVelocityMaterial::_darcy_velocity

protected

Computed Darcy velocity of each phase.

_darcy_velocity[_qp][ph](i) = i^th component of velocity of phase ph at quadpoint _qp

Definition at line 79 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _ddarcy_velocity_dgradvar

MaterialProperty<std::vector<std::vector<std::vector<RealVectorValue> > > >& PorousFlowDarcyVelocityMaterial::_ddarcy_velocity_dgradvar

protected

_ddarcy_velocity_dgradvar[_qp][ph][j][v](i) = d(i_th component of Darcy velocity of phase ph at quadpoint _qp) / d(j_th component of grad(PorousFlow variable v)) In an advection Kernel, grad_test * _darcy_velocity[ph] * u, the contribution to the Jacobian is grad_test * (_ddarcy_velocity_dgradvar[_qp][ph][j][v] * _grad_phi[_j][_qp](j)) * u

Definition at line 95 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _ddarcy_velocity_dvar

MaterialProperty<std::vector<std::vector<RealVectorValue> > >& PorousFlowDarcyVelocityMaterial::_ddarcy_velocity_dvar

protected

_ddarcy_velocity_dvar[_qp][ph][v](i) = d(i_th component of velocity of phase ph at quadpoint _qp)/d(PorousFlow variable v)

Definition at line 85 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _dfluid_density_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowDarcyVelocityMaterial::_dfluid_density_dvar

protected

Derivative of the fluid density for each phase wrt PorousFlow variables.

Definition at line 49 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _dfluid_viscosity_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowDarcyVelocityMaterial::_dfluid_viscosity_dvar

protected

Derivative of the fluid viscosity for each phase wrt PorousFlow variables.

Definition at line 55 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _dgrad_p_dgradvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowDarcyVelocityMaterial::_dgrad_p_dgradvar

protected

Derivative of Grad porepressure in each phase wrt grad(PorousFlow variables)

Definition at line 67 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _dgrad_p_dvar

const MaterialProperty<std::vector<std::vector<RealGradient> > >& PorousFlowDarcyVelocityMaterial::_dgrad_p_dvar

protected

Derivative of Grad porepressure in each phase wrt PorousFlow variables.

Definition at line 70 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _dictator

const PorousFlowDictator& PorousFlowMaterial::_dictator

protectedinherited

The variable names UserObject for the PorousFlow variables.

Definition at line 71 of file PorousFlowMaterial.h.

◆ _dpermeability_dgradvar

const MaterialProperty<std::vector<std::vector<RealTensorValue> > >& PorousFlowDarcyVelocityMaterial::_dpermeability_dgradvar

protected

d(permeabiity)/d(grad(PorousFlow variable))

Definition at line 43 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _dpermeability_dvar

const MaterialProperty<std::vector<RealTensorValue> >& PorousFlowDarcyVelocityMaterial::_dpermeability_dvar

protected

d(permeabiity)/d(PorousFlow variable)

Definition at line 40 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _drelative_permeability_dvar

const MaterialProperty<std::vector<std::vector<Real> > >& PorousFlowDarcyVelocityMaterial::_drelative_permeability_dvar

protected

Derivative of relative permeability of each phase wrt PorousFlow variables.

Definition at line 61 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _fluid_density

const MaterialProperty<std::vector<Real> >& PorousFlowDarcyVelocityMaterial::_fluid_density

protected

Fluid density for each phase.

Definition at line 46 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _fluid_viscosity

const MaterialProperty<std::vector<Real> >& PorousFlowDarcyVelocityMaterial::_fluid_viscosity

protected

Viscosity of each component in each phase.

Definition at line 52 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _grad_p

const MaterialProperty<std::vector<RealGradient> >& PorousFlowDarcyVelocityMaterial::_grad_p

protected

Gradient of the pore pressure in each phase.

Definition at line 64 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _gravity

const RealVectorValue PorousFlowDarcyVelocityMaterial::_gravity

protected

Gravity.

Definition at line 73 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _mass_fraction_variable_name

const VariableName PorousFlowMaterial::_mass_fraction_variable_name

protectedinherited

Definition at line 78 of file PorousFlowMaterial.h.

◆ _nodal_material

const bool PorousFlowMaterial::_nodal_material

protectedinherited

Whether the derived class holds nodal values.

Definition at line 68 of file PorousFlowMaterial.h.

Referenced by PorousFlowMaterial::computeProperties(), PorousFlowMaterial::initialSetup(), PorousFlowMaterial::initStatefulProperties(), and PorousFlowDarcyVelocityMaterial().

◆ _num_phases

const unsigned int PorousFlowDarcyVelocityMaterial::_num_phases

protected

Number of phases.

Definition at line 31 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _num_var

const unsigned int PorousFlowDarcyVelocityMaterial::_num_var

protected

Number of PorousFlow variables.

Definition at line 34 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _permeability

const MaterialProperty<RealTensorValue>& PorousFlowDarcyVelocityMaterial::_permeability

protected

Permeability of porous material.

Definition at line 37 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _pressure_variable_name

const VariableName PorousFlowMaterial::_pressure_variable_name

protectedinherited

Names of variables used to declare/get derivatives in the DerivativeMaterialInterface to ensure consistency.

Definition at line 75 of file PorousFlowMaterial.h.

◆ _relative_permeability

const MaterialProperty<std::vector<Real> >& PorousFlowDarcyVelocityMaterial::_relative_permeability

protected

Relative permeability of each phase.

Definition at line 58 of file PorousFlowDarcyVelocityMaterial.h.

Referenced by computeQpProperties().

◆ _saturation_variable_name

const VariableName PorousFlowMaterial::_saturation_variable_name

protectedinherited

Definition at line 76 of file PorousFlowMaterial.h.

◆ _temperature_variable_name

const VariableName PorousFlowMaterial::_temperature_variable_name

protectedinherited

Definition at line 77 of file PorousFlowMaterial.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PorousFlowDarcyVelocityMaterial()

Member Function Documentation

◆ computeProperties()

◆ computeQpProperties()

◆ initialSetup()

◆ initStatefulProperties()

◆ nearestQP()

◆ sizeNodalProperties()

Member Data Documentation

◆ _darcy_velocity

◆ _ddarcy_velocity_dgradvar

◆ _ddarcy_velocity_dvar

◆ _dfluid_density_dvar

◆ _dfluid_viscosity_dvar

◆ _dgrad_p_dgradvar

◆ _dgrad_p_dvar

◆ _dictator

◆ _dpermeability_dgradvar

◆ _dpermeability_dvar

◆ _drelative_permeability_dvar

◆ _fluid_density

◆ _fluid_viscosity

◆ _grad_p

◆ _gravity

◆ _mass_fraction_variable_name

◆ _nodal_material

◆ _num_phases

◆ _num_var

◆ _permeability

◆ _pressure_variable_name

◆ _relative_permeability

◆ _saturation_variable_name

◆ _temperature_variable_name