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

3.3.0

DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media

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

#include <dumux/geometry/intersectionentityset.hh>

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 More...

using	EntityIterator = typename Intersections::const_iterator
	make entity iterator type available More...

Public Member Functions
	IntersectionEntitySet ()=default
	Default constructor. More...

void	build (std::shared_ptr< const DomainEntitySet > domainSet, std::shared_ptr< const TargetEntitySet > targetSet)
	Build intersections. More...

void	build (std::shared_ptr< const DomainTree > domainTree, std::shared_ptr< const TargetTree > targetTree)
	Build intersections. More...

void	build (const DomainTree &domainTree, const TargetTree &targetTree)
	Build intersections. More...

Intersections::const_iterator	ibegin () const
	return begin iterator to intersection container More...

Intersections::const_iterator	iend () const
	return end iterator to intersection container More...

std::size_t	size () const
	the number of intersections More...

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:

geometry/intersectionentityset.hh