Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet > Class Template Reference

A class representing the intersection entites two geometric entity sets. More...

#include <dumux/common/geometry/intersectionentityset.hh>

Inheritance diagram for Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >:

Description

template<class DomainEntitySet, class TargetEntitySet>
class Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >

A class representing the intersection entites two geometric entity sets.

Public Types
using	Entity = IntersectionEntity
	make intersection entity type available
using	EntityIterator = typename Intersections::const_iterator
	make entity iterator type available

Public Member Functions
	IntersectionEntitySet ()=default
	Default constructor.
void	build (std::shared_ptr< const DomainEntitySet > domainSet, std::shared_ptr< const TargetEntitySet > targetSet)
	Build intersections.
void	build (std::shared_ptr< const DomainTree > domainTree, std::shared_ptr< const TargetTree > targetTree)
	Build intersections.
void	build (const DomainTree &domainTree, const TargetTree &targetTree)
	Build intersections.
Intersections::const_iterator	ibegin () const
	return begin iterator to intersection container
Intersections::const_iterator	iend () const
	return end iterator to intersection container
std::size_t	size () const
	the number of intersections

Member Typedef Documentation

Entity

template<class DomainEntitySet, class TargetEntitySet>

using Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::Entity = IntersectionEntity

make intersection entity type available

EntityIterator

template<class DomainEntitySet, class TargetEntitySet>

using Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::EntityIterator = typename Intersections::const_iterator

make entity iterator type available

Constructor & Destructor Documentation

IntersectionEntitySet()

template<class DomainEntitySet, class TargetEntitySet>

Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::IntersectionEntitySet ( )

default

Default constructor.

Member Function Documentation

build() [1/3]

template<class DomainEntitySet, class TargetEntitySet>

void Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::build ( const DomainTree & domainTree, const TargetTree & targetTree )

inline

Build intersections.

Note

If you call this, make sure the bounding box tree stays alive for the life-time of this object

build() [2/3]

template<class DomainEntitySet, class TargetEntitySet>

void Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::build ( std::shared_ptr< const DomainEntitySet > domainSet, std::shared_ptr< const TargetEntitySet > targetSet )

inline

Build intersections.

build() [3/3]

template<class DomainEntitySet, class TargetEntitySet>

void Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::build ( std::shared_ptr< const DomainTree > domainTree, std::shared_ptr< const TargetTree > targetTree )

inline

Build intersections.

ibegin()

template<class DomainEntitySet, class TargetEntitySet>

Intersections::const_iterator Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::ibegin ( ) const

inline

return begin iterator to intersection container

iend()

template<class DomainEntitySet, class TargetEntitySet>

Intersections::const_iterator Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::iend ( ) const

inline

return end iterator to intersection container

size()

template<class DomainEntitySet, class TargetEntitySet>

std::size_t Dumux::IntersectionEntitySet< DomainEntitySet, TargetEntitySet >::size ( ) const

inline

the number of intersections

---

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

• intersectionentityset.hh