PorousFlowMaterial Class Reference

PorousFlowMaterial is the base class for all PorousFlow Materials It allows users to specify that the Material should be a "nodal" Material, in which Material Properties will be evaluated at nodes (using the Variable's nodal values rather than their quadpoint values). More...

#include <PorousFlowMaterial.h>

Inheritance diagram for PorousFlowMaterial:

Public Member Functions
	PorousFlowMaterial (const InputParameters &parameters)
virtual void	initialSetup () override

Protected Member Functions
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 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

PorousFlowMaterial is the base class for all PorousFlow Materials It allows users to specify that the Material should be a "nodal" Material, in which Material Properties will be evaluated at nodes (using the Variable's nodal values rather than their quadpoint values).

In a derived class's computeQpProperties, _qp must be recognized as a label for a quadpoint (for ordinary Materials) or a node (for nodal Materials).

For the nodal Material case, the Material Properties are sized to max(number of nodes, number of quadpoints). Only "number of nodes" of these will ever be computed and used: the remaining ones (if any) exist just to make sure that the vectors are correctly sized in MOOSE's copying operations (etc).

If number of quadpoints < number of nodes (eg for boundary elements) care should be taken to store the required nodal information in the first number_of_quadpoint elements in the std::vector!

Definition at line 40 of file PorousFlowMaterial.h.

Constructor & Destructor Documentation

PorousFlowMaterial()

PorousFlowMaterial::PorousFlowMaterial

(

const InputParameters &

parameters

)

Definition at line 29 of file PorousFlowMaterial.C.

  : Material(parameters),
    _nodal_material(getParam<bool>("at_nodes")),
    _dictator(getUserObject<PorousFlowDictator>("PorousFlowDictator")),
    _pressure_variable_name("pressure_variable"),
    _saturation_variable_name("saturation_variable"),
    _temperature_variable_name("temperature_variable"),
    _mass_fraction_variable_name("mass_fraction_variable")
{
}

Member Function Documentation

computeProperties()

void PorousFlowMaterial::computeProperties ( )

overrideprotectedvirtual

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();
}

initialSetup()

void PorousFlowMaterial::initialSetup ( )

overridevirtual

Definition at line 41 of file PorousFlowMaterial.C.

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

initStatefulProperties()

void PorousFlowMaterial::initStatefulProperties ( unsigned int  n_points )

overrideprotectedvirtual

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

protected

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 ( )

protected

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 computeProperties(), and initStatefulProperties().

Member Data Documentation

_dictator

const PorousFlowDictator& PorousFlowMaterial::_dictator

protected

The variable names UserObject for the PorousFlow variables.

Definition at line 71 of file PorousFlowMaterial.h.

_mass_fraction_variable_name

const VariableName PorousFlowMaterial::_mass_fraction_variable_name

protected

Definition at line 78 of file PorousFlowMaterial.h.

_nodal_material

const bool PorousFlowMaterial::_nodal_material

protected

Whether the derived class holds nodal values.

Definition at line 68 of file PorousFlowMaterial.h.

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

_pressure_variable_name

const VariableName PorousFlowMaterial::_pressure_variable_name

protected

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

Definition at line 75 of file PorousFlowMaterial.h.

_saturation_variable_name

const VariableName PorousFlowMaterial::_saturation_variable_name

protected

Definition at line 76 of file PorousFlowMaterial.h.

_temperature_variable_name

const VariableName PorousFlowMaterial::_temperature_variable_name

protected

Definition at line 77 of file PorousFlowMaterial.h.

---

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

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