DuMuX: Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView > Class Template Reference

3.5-git

DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media

Base class for geometry data extraction from the grid data format. More...

#include <dumux/discretization/porenetwork/gridgeometry.hh>

Description

template<class Scalar, class GridView>
class Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >

Base class for geometry data extraction from the grid data format.

Public Member Functions
template<class GridData >
void	update (const GridView &gridView, const GridData &gridData)

Label	poreLabel (const GridIndex dofIdxGlobal) const
	Returns the pore label (e.g. used for setting BCs) More...

const std::vector< Label > &	poreLabel () const
	Returns the vector of pore labels. More...

Scalar	poreInscribedRadius (const GridIndex dofIdxGlobal) const
	Returns the inscribed radius of the pore. More...

const std::vector< Scalar > &	poreInscribedRadius () const
	Returns the vector of inscribed pore radii. More...

Scalar	poreVolume (const GridIndex dofIdxGlobal) const
	Returns the volume of the pore. More...

const std::vector< Scalar > &	poreVolume () const
	Returns the vector of pore volumes. More...

Scalar	throatInscribedRadius (const GridIndex eIdx) const
	Returns the inscribed radius of the throat. More...

const std::vector< Scalar > &	throatInscribedRadius () const
	Returns the vector of inscribed throat radii. More...

Scalar	throatLength (const GridIndex eIdx) const
	Returns the length of the throat. More...

const std::vector< Scalar > &	throatLength () const
	Returns the vector of throat lengths. More...

Label	throatLabel (const GridIndex eIdx) const
	Returns an index indicating if a throat is touching the domain boundary. More...

const std::vector< Label > &	throatLabel () const
	Returns the vector of throat labels. More...

SmallLocalIndex	coordinationNumber (const GridIndex dofIdxGlobal) const
	Returns the number of throats connected to a pore (coordination number) More...

const std::vector< SmallLocalIndex > &	coordinationNumber () const
	Returns the vector of coordination numbers. More...

Pore::Shape	poreGeometry (const GridIndex vIdx) const
	the geometry of the pore More...

const std::vector< Pore::Shape > &	poreGeometry () const
	Returns the vector of pore geometries. More...

Throat::Shape	throatCrossSectionShape (const GridIndex eIdx) const
	Returns the throat's cross-sectional shape. More...

const std::vector< Throat::Shape > &	throatCrossSectionShape () const
	Returns the vector of cross-sectional shapes. More...

Scalar	throatCrossSectionalArea (const GridIndex eIdx) const
	Returns the throat's cross-sectional area. More...

const std::vector< Scalar > &	throatCrossSectionalArea () const
	Returns the vector of throat cross-sectional areas. More...

Scalar	throatShapeFactor (const GridIndex eIdx) const
	Returns the throat's shape factor. More...

const std::vector< Scalar > &	throatShapeFactor () const
	Returns the vector of throat shape factors. More...

bool	useSameGeometryForAllPores () const
	Returns whether all pores feature the same shape. More...

bool	useSameShapeForAllThroats () const
	Returns whether all throats feature the same cross-sectional shape. More...

Member Function Documentation

◆ coordinationNumber() [1/2]

template<class Scalar , class GridView >

const std::vector< SmallLocalIndex > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::coordinationNumber ( ) const

inline

Returns the vector of coordination numbers.

◆ coordinationNumber() [2/2]

template<class Scalar , class GridView >

SmallLocalIndex Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::coordinationNumber ( const GridIndex dofIdxGlobal ) const

inline

Returns the number of throats connected to a pore (coordination number)

◆ poreGeometry() [1/2]

template<class Scalar , class GridView >

const std::vector< Pore::Shape > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreGeometry ( ) const

inline

Returns the vector of pore geometries.

◆ poreGeometry() [2/2]

template<class Scalar , class GridView >

Pore::Shape Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreGeometry ( const GridIndex vIdx ) const

inline

the geometry of the pore

◆ poreInscribedRadius() [1/2]

template<class Scalar , class GridView >

const std::vector< Scalar > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreInscribedRadius ( ) const

inline

Returns the vector of inscribed pore radii.

◆ poreInscribedRadius() [2/2]

template<class Scalar , class GridView >

Scalar Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreInscribedRadius ( const GridIndex dofIdxGlobal ) const

inline

Returns the inscribed radius of the pore.

◆ poreLabel() [1/2]

template<class Scalar , class GridView >

const std::vector< Label > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreLabel ( ) const

inline

Returns the vector of pore labels.

◆ poreLabel() [2/2]

template<class Scalar , class GridView >

Label Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreLabel ( const GridIndex dofIdxGlobal ) const

inline

Returns the pore label (e.g. used for setting BCs)

◆ poreVolume() [1/2]

template<class Scalar , class GridView >

const std::vector< Scalar > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreVolume ( ) const

inline

Returns the vector of pore volumes.

◆ poreVolume() [2/2]

template<class Scalar , class GridView >

Scalar Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::poreVolume ( const GridIndex dofIdxGlobal ) const

inline

Returns the volume of the pore.

◆ throatCrossSectionalArea() [1/2]

template<class Scalar , class GridView >

const std::vector< Scalar > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatCrossSectionalArea ( ) const

inline

Returns the vector of throat cross-sectional areas.

◆ throatCrossSectionalArea() [2/2]

template<class Scalar , class GridView >

Scalar Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatCrossSectionalArea ( const GridIndex eIdx ) const

inline

Returns the throat's cross-sectional area.

◆ throatCrossSectionShape() [1/2]

template<class Scalar , class GridView >

const std::vector< Throat::Shape > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatCrossSectionShape ( ) const

inline

Returns the vector of cross-sectional shapes.

◆ throatCrossSectionShape() [2/2]

template<class Scalar , class GridView >

Throat::Shape Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatCrossSectionShape ( const GridIndex eIdx ) const

inline

Returns the throat's cross-sectional shape.

◆ throatInscribedRadius() [1/2]

template<class Scalar , class GridView >

const std::vector< Scalar > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatInscribedRadius ( ) const

inline

Returns the vector of inscribed throat radii.

◆ throatInscribedRadius() [2/2]

template<class Scalar , class GridView >

Scalar Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatInscribedRadius ( const GridIndex eIdx ) const

inline

Returns the inscribed radius of the throat.

◆ throatLabel() [1/2]

template<class Scalar , class GridView >

const std::vector< Label > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatLabel ( ) const

inline

Returns the vector of throat labels.

◆ throatLabel() [2/2]

template<class Scalar , class GridView >

Label Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatLabel ( const GridIndex eIdx ) const

inline

Returns an index indicating if a throat is touching the domain boundary.

◆ throatLength() [1/2]

template<class Scalar , class GridView >

const std::vector< Scalar > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatLength ( ) const

inline

Returns the vector of throat lengths.

◆ throatLength() [2/2]

template<class Scalar , class GridView >

Scalar Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatLength ( const GridIndex eIdx ) const

inline

Returns the length of the throat.

◆ throatShapeFactor() [1/2]

template<class Scalar , class GridView >

const std::vector< Scalar > & Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatShapeFactor ( ) const

inline

Returns the vector of throat shape factors.

◆ throatShapeFactor() [2/2]

template<class Scalar , class GridView >

Scalar Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::throatShapeFactor ( const GridIndex eIdx ) const

inline

Returns the throat's shape factor.

◆ update()

template<class Scalar , class GridView >

template<class GridData >

void Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::update	(	const GridView &	gridView,
		const GridData &	gridData
	)

inline

◆ useSameGeometryForAllPores()

template<class Scalar , class GridView >

bool Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::useSameGeometryForAllPores ( ) const

inline

Returns whether all pores feature the same shape.

◆ useSameShapeForAllThroats()

template<class Scalar , class GridView >

bool Dumux::PoreNetwork::DefaultPNMData< Scalar, GridView >::useSameShapeForAllThroats ( ) const

inline

Returns whether all throats feature the same cross-sectional shape.

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

discretization/porenetwork/gridgeometry.hh