dune-mmesh (unstable)

Dune::Distance< Grid > Class Template Reference

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

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

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 More...
 
void set (const Vertex &vertex, ctype value)
 Set distance of vertex. More...
 
ctype operator() (const Element &element) const
 function call operator to return distance of element (average of the vertex distances) More...
 
ctype operator() (const InterfaceElement &element) const
 Interface element.
 
template<class Index >
ctype operator[] (const Index &index) const
 function call operator to return distance More...
 
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.

Member Function Documentation

◆ operator()() [1/2]

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
elementA grid element

◆ operator()() [2/2]

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

function call operator to return distance of vertex

Parameters
vertexA grid vertex

References Dune::Distance< Grid >::size().

◆ operator[]()

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

function call operator to return distance

Parameters
indexIndex of a vertex

◆ set()

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

Set distance of vertex.

Parameters
vertexA grid vertex
valueDistance value

References Dune::Distance< Grid >::size().


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden & Uni Heidelberg  |  generated with Hugo v0.111.3 (Mar 17, 23:30, 2025)