Dumux::BoundingBoxGeometry< ct, dimworld > Class Template Reference

A thin axis-aligned box geometry. More...

#include <dumux/geometry/boundingboxgeometry.hh>

Inheritance diagram for Dumux::BoundingBoxGeometry< ct, dimworld >:

Description

template<class ct, int dimworld>
class Dumux::BoundingBoxGeometry< ct, dimworld >

Provides the minimal geometry interface required by Dumux::BoundingBoxTree (corner access and geometry type), backed only by the lower and upper corner coordinates. This is useful to build a bounding box tree over a set of plain bounding boxes (e.g. the per-process partition boxes of a distributed tree) without the overhead of a full Dune geometry.

Public Types
using	ctype = ct
using	GlobalCoordinate = Dune::FieldVector<ct, dimworld>

Public Member Functions
	BoundingBoxGeometry ()=default
	BoundingBoxGeometry (const GlobalCoordinate &lower, const GlobalCoordinate &upper)
	Construct from the lower and upper corner of the box.
int	corners () const
	the number of corners of the box
GlobalCoordinate	corner (int i) const
	the i-th corner in Dune reference-cube ordering
Dune::GeometryType	type () const
	the geometry type (an axis-aligned cube)
const GlobalCoordinate &	lower () const
	the lower (min) corner of the box
const GlobalCoordinate &	upper () const
	the upper (max) corner of the box

Static Public Attributes
static constexpr int	mydimension = dimworld
static constexpr int	coorddimension = dimworld

Member Typedef Documentation

ctype

template<class ct, int dimworld>

using Dumux::BoundingBoxGeometry< ct, dimworld >::ctype = ct

GlobalCoordinate

template<class ct, int dimworld>

using Dumux::BoundingBoxGeometry< ct, dimworld >::GlobalCoordinate = Dune::FieldVector<ct, dimworld>

Constructor & Destructor Documentation

BoundingBoxGeometry() [1/2]

template<class ct, int dimworld>

Dumux::BoundingBoxGeometry< ct, dimworld >::BoundingBoxGeometry ( )

default

BoundingBoxGeometry() [2/2]

template<class ct, int dimworld>

Dumux::BoundingBoxGeometry< ct, dimworld >::BoundingBoxGeometry ( const GlobalCoordinate & lower, const GlobalCoordinate & upper )

inline

Member Function Documentation

corner()

template<class ct, int dimworld>

GlobalCoordinate Dumux::BoundingBoxGeometry< ct, dimworld >::corner ( int i ) const

inline

corners()

template<class ct, int dimworld>

int Dumux::BoundingBoxGeometry< ct, dimworld >::corners ( ) const

inline

lower()

template<class ct, int dimworld>

const GlobalCoordinate & Dumux::BoundingBoxGeometry< ct, dimworld >::lower ( ) const

inline

type()

template<class ct, int dimworld>

Dune::GeometryType Dumux::BoundingBoxGeometry< ct, dimworld >::type ( ) const

inline

upper()

template<class ct, int dimworld>

const GlobalCoordinate & Dumux::BoundingBoxGeometry< ct, dimworld >::upper ( ) const

inline

Member Data Documentation

coorddimension

template<class ct, int dimworld>

int Dumux::BoundingBoxGeometry< ct, dimworld >::coorddimension = dimworld

staticconstexpr

mydimension

template<class ct, int dimworld>

int Dumux::BoundingBoxGeometry< ct, dimworld >::mydimension = dimworld

staticconstexpr

---

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

• boundingboxgeometry.hh