Dune::Fufem::Boundary< GV > Class Template Reference

#include <dune/fufem/domains/boundary.hh>

Description

template<class GV>
class Dune::Fufem::Boundary< GV >

Encapsulate the set of the boundary intersections of a GridView.

Template Parameters

GV	The grid view on which this boundary lives

Public Types
using	GridView = GV
	GridView type the boundary is associated to.
using	iterator = Dune::Fufem::IntersectionSetIterator< Boundary >
	Export the appropriate iterator type.

Public Member Functions
	Boundary (const GridView &gridView)
	Construct boundary object for given gridview.
const GridView &	gridView () const
	Return GridView the boundary is associated to.
constexpr bool	contains (const Intersection &intersection) const
	Return true for all boundary intersections.
bool	containsFaceOf (const Element &element) const
	Return true if the element may have a face on the boundary.
iterator	begin () const
	Return iterator pointing to first boundary face.
iterator	end () const
	Return iterator pointing after last boundary face.

Member Typedef Documentation

GridView

template<class GV >

using Dune::Fufem::Boundary< GV >::GridView = GV

GridView type the boundary is associated to.

iterator

template<class GV >

using Dune::Fufem::Boundary< GV >::iterator = Dune::Fufem::IntersectionSetIterator<Boundary>

Export the appropriate iterator type.

Constructor & Destructor Documentation

Boundary()

template<class GV >

Dune::Fufem::Boundary< GV >::Boundary ( const GridView &  gridView )

inline

Construct boundary object for given gridview.

Member Function Documentation

begin()

template<class GV >

iterator Dune::Fufem::Boundary< GV >::begin ( ) const

inline

Return iterator pointing to first boundary face.

contains()

template<class GV >

constexpr bool Dune::Fufem::Boundary< GV >::contains ( const Intersection &  intersection ) const

inlineconstexpr

Return true for all boundary intersections.

The result is unspecified, if containsFaceOf(intersection.inside()) is false.

containsFaceOf()

template<class GV >

bool Dune::Fufem::Boundary< GV >::containsFaceOf ( const Element &  element ) const

inline

Return true if the element may have a face on the boundary.

Notice that it is allowed to return true if there are no boundary intersections, while it is guaranteed that there are no boundary intersections if the method returns false.

end()

template<class GV >

iterator Dune::Fufem::Boundary< GV >::end ( ) const

inline

Return iterator pointing after last boundary face.

gridView()

template<class GV >

const GridView & Dune::Fufem::Boundary< GV >::gridView ( ) const

inline

Return GridView the boundary is associated to.

---

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

• boundary.hh