Dumux::AABBDistanceField< Geometry > Class Template Reference

Class to calculate the closest distance from a point to a given set of geometries describing the domain's boundaries. Internally uses an AABB tree representation of the geometries for logarithmic distance queries. More...

#include <dumux/geometry/distancefield.hh>

Description

template<class Geometry>
class Dumux::AABBDistanceField< Geometry >

Template Parameters

Geometry

The (dune) geometry type.

Public Member Functions
	AABBDistanceField (const std::vector< Geometry > &geometries)
	The constructor. More...
std::pair< Scalar, std::size_t >	distanceAndIndex (const Point &p) const
	Returns the distance from a point to the closest geometry on the domain's boundary, as well as the index of the closest geometry. More...
Scalar	distance (const Point &p) const
	Returns the distance from a point to the closest geometry on the domain's boundary. More...

Constructor & Destructor Documentation

AABBDistanceField()

template<class Geometry >

Dumux::AABBDistanceField< Geometry >::AABBDistanceField ( const std::vector< Geometry > &  geometries )

inline

Parameters

geometries

A vector of geometries describing the boundaries of the spatial domain.

Member Function Documentation

distance()

template<class Geometry >

Scalar Dumux::AABBDistanceField< Geometry >::distance ( const Point &  p ) const

inline

Parameters

p	The location at which the closest distance is evaluated.

distanceAndIndex()

template<class Geometry >

std::pair< Scalar, std::size_t > Dumux::AABBDistanceField< Geometry >::distanceAndIndex ( const Point &  p ) const

inline

Parameters

p	The location at which the closest distance is evaluated.

---

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

• distancefield.hh