Dumux::PoreNetwork::Pore Namespace Reference

Enumerations
enum class	Shape {   circle , square , cube , sphere ,   cylinder , tetrahedron , octahedron , icosahedron ,   dodecahedron }
	Collection of different pore-body shapes. More...

Functions
std::string	shapeToString (Shape s)
	Get the shape from a string description of the shape. More...
Shape	shapeFromString (const std::string &s)
	Get the shape from a string description of the shape. More...
template<class Scalar >
Scalar	volume (Shape shape, Scalar inscribedRadius)
	Returns the volume of a given geometry based on the inscribed radius. More...
template<class Scalar >
Scalar	volume (Shape shape, Scalar inscribedRadius, Scalar height)
	Returns the volume of a given geometry based on the inscribed radius and the height. More...

Enumeration Type Documentation

Shape

enum class Dumux::PoreNetwork::Pore::Shape

strong

Collection of different pore-body shapes.

Enumerator
circle
square
cube
sphere
cylinder
tetrahedron
octahedron
icosahedron
dodecahedron

Function Documentation

shapeFromString()

Shape Dumux::PoreNetwork::Pore::shapeFromString ( const std::string &  s )

inline

Get the shape from a string description of the shape.

shapeToString()

std::string Dumux::PoreNetwork::Pore::shapeToString ( Shape  s )

inline

Get the shape from a string description of the shape.

volume() [1/2]

template<class Scalar >

Scalar Dumux::PoreNetwork::Pore::volume ( Shape  shape, Scalar  inscribedRadius  )

inline

Returns the volume of a given geometry based on the inscribed radius.

volume() [2/2]

template<class Scalar >

Scalar Dumux::PoreNetwork::Pore::volume ( Shape  shape, Scalar  inscribedRadius, Scalar  height  )

inline

Returns the volume of a given geometry based on the inscribed radius and the height.