version 3.10-dev
throatproperties.hh File Reference

This file contains functions related to calculate pore-throat properties. More...

#include <string>
#include <cmath>
#include <numeric>
#include <dune/common/exceptions.hh>
#include <dune/common/reservedvector.hh>

Go to the source code of this file.

Namespaces

namespace  Dumux
 
namespace  Dumux::PoreNetwork
 
namespace  Dumux::PoreNetwork::Throat
 

Enumerations

enum class  Dumux::PoreNetwork::Throat::Shape {
  Dumux::PoreNetwork::Throat::scaleneTriangle , Dumux::PoreNetwork::Throat::equilateralTriangle , Dumux::PoreNetwork::Throat::square , Dumux::PoreNetwork::Throat::rectangle ,
  Dumux::PoreNetwork::Throat::circle , Dumux::PoreNetwork::Throat::twoPlates , Dumux::PoreNetwork::Throat::polygon
}
 Collection of different pore-throat shapes. More...
 

Functions

std::string Dumux::PoreNetwork::Throat::shapeToString (Shape s)
 Get the shape from a string description of the shape. More...
 
Shape Dumux::PoreNetwork::Throat::shapeFromString (const std::string &s)
 Get the shape from a string description of the shape. More...
 
template<class Scalar >
Scalar Dumux::PoreNetwork::Throat::averagedRadius (const Scalar poreRadiusOne, const Scalar poreRadiusTwo, const Scalar centerTocenterDist, const Scalar n=0.1)
 Returns the radius of a pore throat. More...
 
template<class Scalar >
Dune::ReservedVector< Scalar, 4 > Dumux::PoreNetwork::Throat::cornerHalfAngles (Shape shape)
 Returns the corner half angle. More...
 
template<class Scalar >
constexpr Scalar Dumux::PoreNetwork::Throat::shapeFactorEquilateralTriangle () noexcept
 Returns the value of the shape factor for an equilateral triangle. More...
 
template<class Scalar >
constexpr Scalar Dumux::PoreNetwork::Throat::shapeFactorSquare () noexcept
 Returns the value of the shape factor for a square. More...
 
template<class Scalar >
constexpr Scalar Dumux::PoreNetwork::Throat::shapeFactorRectangle (const Scalar inscribedRadius, const Scalar height) noexcept
 Returns the value of the shape factor for a rectangle. More...
 
template<class Scalar >
constexpr Scalar Dumux::PoreNetwork::Throat::shapeFactorCircle () noexcept
 Returns the value of the shape factor for a circle. More...
 
template<class Scalar >
Scalar Dumux::PoreNetwork::Throat::shapeFactor (Shape shape, const Scalar inscribedRadius)
 Returns the value of the shape factor for a given shape. More...
 
template<class Scalar >
constexpr Shape Dumux::PoreNetwork::Throat::shape (const Scalar shapeFactor) noexcept
 Returns the shape for a given shape factor. More...
 
bool Dumux::PoreNetwork::Throat::isRegularShape (Shape shape)
 Returns if a shape is regular. More...
 
template<class Scalar >
Scalar Dumux::PoreNetwork::Throat::totalCrossSectionalArea (const Shape shape, const Scalar inscribedRadius)
 Returns the cross-sectional area of a given geometry. More...
 
template<class Scalar >
constexpr Scalar Dumux::PoreNetwork::Throat::totalCrossSectionalAreaForRectangle (const Scalar inscribedRadius, const Scalar height) noexcept
 Returns the cross-sectional area of a rectangle. More...
 
std::size_t Dumux::PoreNetwork::Throat::numCorners (Shape shape)
 Returns the number of corners of a given geometry. More...
 
template<class Scalar >
constexpr Scalar Dumux::PoreNetwork::Throat::wettingLayerCrossSectionalArea (const Scalar curvatureRadius, const Scalar contactAngle, const Scalar cornerHalfAngle) noexcept
 Return the cross-sectional area of a wetting layer residing in a corner of a throat. More...
 
Include dependency graph for throatproperties.hh: