Dune::Distance< Grid > Class Template Reference

Class for computing the distance to the interface. More...

#include <dune/mmesh/remeshing/distance.hh>

Inheritance diagram for Dune::Distance< Grid >:

Public Member Functions
	Distance ()
	Default constructor.
	Distance (const Grid &grid)
	Constructor with grid reference.
void	update ()
	Update the distances of all vertices.
bool	initialized () const
	Return if distance has been initialized.
ctype	operator() (const Vertex &vertex) const
	function call operator to return distance of vertex
void	set (const Vertex &vertex, ctype value)
	Set distance of vertex.
ctype	operator() (const Element &element) const
	function call operator to return distance of element (average of the vertex distances)
ctype	operator() (const InterfaceElement &element) const
	Interface element.
template<class Index >
ctype	operator[] (const Index &index) const
	function call operator to return distance
ctype	maximum () const
	return maximum distance
std::size_t	size () const
	return size of distances vector

Detailed Description

template<class Grid>
class Dune::Distance< Grid >

Class for computing the distance to the interface.

Constructor & Destructor Documentation

Distance() [1/2]

template<class Grid >

Dune::Distance< Grid >::Distance ( )

inline

Default constructor.

Distance() [2/2]

template<class Grid >

Dune::Distance< Grid >::Distance ( const Grid &  grid )

inline

Constructor with grid reference.

Member Function Documentation

initialized()

template<class Grid >

bool Dune::Distance< Grid >::initialized ( ) const

inline

Return if distance has been initialized.

maximum()

template<class Grid >

ctype Dune::Distance< Grid >::maximum ( ) const

inline

return maximum distance

operator()() [1/3]

template<class Grid >

ctype Dune::Distance< Grid >::operator() ( const Element &  element ) const

inline

function call operator to return distance of element (average of the vertex distances)

Parameters

element

A grid element

operator()() [2/3]

template<class Grid >

ctype Dune::Distance< Grid >::operator() ( const InterfaceElement &  element ) const

inline

Interface element.

operator()() [3/3]

template<class Grid >

ctype Dune::Distance< Grid >::operator() ( const Vertex &  vertex ) const

inline

function call operator to return distance of vertex

Parameters

vertex

A grid vertex

operator[]()

template<class Grid >

template<class Index >

ctype Dune::Distance< Grid >::operator[] ( const Index &  index ) const

inline

function call operator to return distance

Parameters

index

Index of a vertex

set()

template<class Grid >

void Dune::Distance< Grid >::set ( const Vertex &  vertex, ctype  value  )

inline

Set distance of vertex.

Parameters

vertex	A grid vertex
value	Distance value

size()

template<class Grid >

std::size_t Dune::Distance< Grid >::size ( ) const

inline

return size of distances vector

update()

template<class Grid >

void Dune::Distance< Grid >::update ( )

inline

Update the distances of all vertices.

---

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

• mmesh/remeshing/distance.hh