#include <dumux/python/porousmediumflow/spatialparams.hh>

Inheritance diagram for Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >:

Public Types
using	GridGeometry = GridGeometry_

using	Scalar = typename GridGeometry::GridView::ctype

using	Element = typename GridGeometry::GridView::template Codim< 0 >::Entity

using	SubControlVolume = typename GridGeometry::SubControlVolume

using	PermeabilityType = PT

using	GridView = typename GridGeometry::GridView

using	GlobalPosition = typename Element::Geometry::GlobalCoordinate

using	GravityVector = Dune::FieldVector< Scalar, dimWorld >

Public Member Functions
	FVSpatialParamsOneP (std::shared_ptr< const GridGeometry > gridGeometry, pybind11::object pySpatialParams)

template<class ElementSolution >
PermeabilityType	permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const

template<class ElementSolution >
Scalar	porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const

template<class SolidSystem , class ElementSolution >
Scalar	inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const

template<class ElementSolution >
Scalar	extrusionFactor (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return how much the domain is extruded at a given sub-control volume. More...

template<class ElementSolution >
Scalar	temperature (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return the temperature in the given sub-control volume. More...

const GravityVector &	gravity (const GlobalPosition &pos) const
	Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). More...

const GridGeometry &	gridGeometry () const
	The finite volume grid geometry. More...

Static Public Member Functions
static constexpr bool	evaluatePermeabilityAtScvfIP ()

Static Public Attributes
static constexpr bool	isBox = GridGeometry::discMethod == DiscretizationMethods::box

static constexpr int	dimWorld = GridView::dimensionworld

Member Typedef Documentation

◆ Element

template<class GridGeometry_ , class PT >

using Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::Element = typename GridGeometry::GridView::template Codim<0>::Entity

◆ GlobalPosition

template<class GridGeometry_ >

using Dumux::Python::FVSpatialParams< GridGeometry_ >::GlobalPosition = typename Element::Geometry::GlobalCoordinate

inherited

◆ GravityVector

template<class GridGeometry_ >

using Dumux::Python::FVSpatialParams< GridGeometry_ >::GravityVector = Dune::FieldVector<Scalar, dimWorld>

inherited

◆ GridGeometry

template<class GridGeometry_ , class PT >

using Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::GridGeometry = GridGeometry_

◆ GridView

template<class GridGeometry_ >

using Dumux::Python::FVSpatialParams< GridGeometry_ >::GridView = typename GridGeometry::GridView

inherited

◆ PermeabilityType

template<class GridGeometry_ , class PT >

using Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::PermeabilityType = PT

◆ Scalar

template<class GridGeometry_ , class PT >

using Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::Scalar = typename GridGeometry::GridView::ctype

◆ SubControlVolume

template<class GridGeometry_ , class PT >

using Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::SubControlVolume = typename GridGeometry::SubControlVolume

Constructor & Destructor Documentation

◆ FVSpatialParamsOneP()

template<class GridGeometry_ , class PT >

Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::FVSpatialParamsOneP	(	std::shared_ptr< const GridGeometry >	gridGeometry,
		pybind11::object	pySpatialParams
	)

inline

Member Function Documentation

◆ evaluatePermeabilityAtScvfIP()

template<class GridGeometry_ , class PT >

static constexpr bool Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::evaluatePermeabilityAtScvfIP ( )

inlinestaticconstexpr

◆ extrusionFactor()

template<class GridGeometry_ >

template<class ElementSolution >

Scalar Dumux::Python::FVSpatialParams< GridGeometry_ >::extrusionFactor	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol
	)		const

inlineinherited

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

◆ gravity()

template<class GridGeometry_ >

const GravityVector & Dumux::Python::FVSpatialParams< GridGeometry_ >::gravity ( const GlobalPosition & pos ) const

inlineinherited

The default behaviour is a constant gravity vector; if the Problem.EnableGravity parameter is true, \(\boldsymbol{g} = ( 0,\dots,\ -9.81)^T \), else \(\boldsymbol{g} = ( 0,\dots, 0)^T \).

Parameters

pos	the spatial position at which to evaluate the gravity vector

◆ gridGeometry()

template<class GridGeometry_ >

const GridGeometry & Dumux::Python::FVSpatialParams< GridGeometry_ >::gridGeometry ( ) const

inlineinherited

◆ inertVolumeFraction()

template<class GridGeometry_ , class PT >

template<class SolidSystem , class ElementSolution >

Scalar Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::inertVolumeFraction	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol,
		int	compIdx
	)		const

inline

◆ permeability()

template<class GridGeometry_ , class PT >

template<class ElementSolution >

PermeabilityType Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::permeability	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol
	)		const

inline

◆ porosity()

template<class GridGeometry_ , class PT >

template<class ElementSolution >

Scalar Dumux::Python::FVSpatialParamsOneP< GridGeometry_, PT >::porosity	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol
	)		const

inline

◆ temperature()

template<class GridGeometry_ >

template<class ElementSolution >

Scalar Dumux::Python::FVSpatialParams< GridGeometry_ >::temperature	(	const Element &	element,
		const SubControlVolume &	scv,
		const ElementSolution &	elemSol
	)		const

inlineinherited

Member Data Documentation

◆ dimWorld

template<class GridGeometry_ >

constexpr int Dumux::Python::FVSpatialParams< GridGeometry_ >::dimWorld = GridView::dimensionworld

staticconstexprinherited

◆ isBox

template<class GridGeometry_ >

constexpr bool Dumux::Python::FVSpatialParams< GridGeometry_ >::isBox = GridGeometry::discMethod == DiscretizationMethods::box

staticconstexprinherited

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

python/porousmediumflow/spatialparams.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Member Typedef Documentation

◆ Element

◆ GlobalPosition

◆ GravityVector

◆ GridGeometry

◆ GridView

◆ PermeabilityType

◆ Scalar

◆ SubControlVolume

Constructor & Destructor Documentation

◆ FVSpatialParamsOneP()

Member Function Documentation

◆ evaluatePermeabilityAtScvfIP()

◆ extrusionFactor()

◆ gravity()

◆ gridGeometry()

◆ inertVolumeFraction()

◆ permeability()

◆ porosity()

◆ temperature()

Member Data Documentation

◆ dimWorld

◆ isBox