Detailed Description

The class implements a basic permeability model that employs a parameter (for instance a constant parameter or mesh cell dependent parameter) to fill the intrinsic permeability tensor.

Definition at line 24 of file Permeability.h.

#include <Permeability.h>

Inheritance diagram for MaterialLib::PorousMedium::Permeability:

[legend]

Collaboration diagram for MaterialLib::PorousMedium::Permeability:

[legend]

Public Member Functions
	Permeability (ParameterLib::Parameter< double > const &permeability_parameter, int const dimension)

virtual	~Permeability ()=default

virtual Eigen::MatrixXd	getValue (const double t, ParameterLib::SpatialPosition const &pos, const double variable, const double temperature) const

Private Attributes
ParameterLib::Parameter< double > const &	_permeability_parameter

int const	_dimension

Constructor & Destructor Documentation

◆ Permeability()

MaterialLib::PorousMedium::Permeability::Permeability	(	ParameterLib::Parameter< double > const &	permeability_parameter,
		int const	dimension )

inlineexplicit

Definition at line 27 of file Permeability.h.

        : _permeability_parameter(permeability_parameter), _dimension(dimension)
    {
        if (permeability_parameter.getNumberOfGlobalComponents() !=
            _dimension * _dimension)
        {
            OGS_FATAL(
                "The given parameter has {:d} components, but the permeability "
                "tensor is defined for a {:d} dimensional problem.",
                permeability_parameter.getNumberOfGlobalComponents(),
                _dimension);
        }
    }

References _dimension, ParameterLib::Parameter< T >::getNumberOfGlobalComponents(), and OGS_FATAL.

◆ ~Permeability()

virtual MaterialLib::PorousMedium::Permeability::~Permeability ( )

virtualdefault

Member Function Documentation

◆ getValue()

virtual Eigen::MatrixXd MaterialLib::PorousMedium::Permeability::getValue	(	const double	t,
		ParameterLib::SpatialPosition const &	pos,
		const double	variable,
		const double	temperature ) const

inlinevirtual

Get the intrinsic permeability tensor.

Parameters

t	point in time
pos	spatial position
variable	A variable with any double type value.
temperature	Temperature with any double type value.

Reimplemented in MaterialLib::PorousMedium::DupuitPermeability.

Definition at line 52 of file Permeability.h.

    {
        (void)variable;
        (void)temperature;
 
        return Eigen::Map<Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic,
                                        Eigen::RowMajor> const>(
            _permeability_parameter(t, pos).data(), _dimension, _dimension);
    }

References _dimension, and _permeability_parameter.

Referenced by MaterialLib::PorousMedium::DupuitPermeability::getValue().

Member Data Documentation

◆ _dimension

int const MaterialLib::PorousMedium::Permeability::_dimension

private

Definition at line 67 of file Permeability.h.

Referenced by Permeability(), and getValue().

◆ _permeability_parameter

ParameterLib::Parameter<double> const& MaterialLib::PorousMedium::Permeability::_permeability_parameter

private

Definition at line 66 of file Permeability.h.

Referenced by getValue().

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

MaterialLib/PorousMedium/Permeability/Permeability.h