dune-grid  2.11
Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Dune::HierarchicSearch< Grid, IS > Class Template Reference

Search an IndexSet for an Entity containing a given point. More...

#include <dune/grid/utility/hierarchicsearch.hh>

Public Member Functions

 HierarchicSearch (const Grid &g, const IS &is)
 Construct a HierarchicSearch object from a Grid and an IndexSet. More...
 
Entity findEntity (const FieldVector< ct, dimw > &global) const
 Search the IndexSet of this HierarchicSearch for an Entity containing point global. More...
 
template<PartitionIteratorType partition>
Entity findEntity (const FieldVector< ct, dimw > &global) const
 Search the IndexSet of this HierarchicSearch for an Entity containing point global. More...
 

Protected Types

typedef Grid::ctype ct
 get coord type from the grid More...
 
typedef Grid::template Codim< 0 >::Entity Entity
 get entity from the grid More...
 
typedef Grid::HierarchicIterator HierarchicIterator
 type of HierarchicIterator More...
 

Protected Member Functions

Entity hFindEntity (const Entity &entity, const FieldVector< ct, dimw > &global) const
 

Static Protected Member Functions

static std::string formatEntityInformation (const Entity &e)
 

Protected Attributes

const Gridgrid_
 
const IS & indexSet_
 

Static Protected Attributes

static constexpr int dim = Grid::dimension
 get dimension from the grid More...
 
static constexpr int dimw = Grid::dimensionworld
 get world dimension from the grid More...
 

Detailed Description

template<class Grid, class IS>
class Dune::HierarchicSearch< Grid, IS >

Search an IndexSet for an Entity containing a given point.

Member Typedef Documentation

◆ ct

template<class Grid , class IS >
typedef Grid::ctype Dune::HierarchicSearch< Grid, IS >::ct
protected

get coord type from the grid

◆ Entity

template<class Grid , class IS >
typedef Grid::template Codim<0>::Entity Dune::HierarchicSearch< Grid, IS >::Entity
protected

get entity from the grid

◆ HierarchicIterator

template<class Grid , class IS >
typedef Grid::HierarchicIterator Dune::HierarchicSearch< Grid, IS >::HierarchicIterator
protected

type of HierarchicIterator

Constructor & Destructor Documentation

◆ HierarchicSearch()

template<class Grid , class IS >
Dune::HierarchicSearch< Grid, IS >::HierarchicSearch ( const Grid g,
const IS &  is 
)
inline

Construct a HierarchicSearch object from a Grid and an IndexSet.

Member Function Documentation

◆ findEntity() [1/2]

template<class Grid , class IS >
Entity Dune::HierarchicSearch< Grid, IS >::findEntity ( const FieldVector< ct, dimw > &  global) const
inline

Search the IndexSet of this HierarchicSearch for an Entity containing point global.

Exceptions
GridErrorNo element of the coarse grid contains the given coordinate.

◆ findEntity() [2/2]

template<class Grid , class IS >
template<PartitionIteratorType partition>
Entity Dune::HierarchicSearch< Grid, IS >::findEntity ( const FieldVector< ct, dimw > &  global) const
inline

Search the IndexSet of this HierarchicSearch for an Entity containing point global.

Exceptions
GridErrorNo element of the coarse grid contains the given coordinate.

type of LevelIterator

◆ formatEntityInformation()

template<class Grid , class IS >
static std::string Dune::HierarchicSearch< Grid, IS >::formatEntityInformation ( const Entity e)
inlinestaticprotected

◆ hFindEntity()

template<class Grid , class IS >
Entity Dune::HierarchicSearch< Grid, IS >::hFindEntity ( const Entity entity,
const FieldVector< ct, dimw > &  global 
) const
inlineprotected

internal helper method

Parameters
[in]entityEntity whose children should be searched
[in]globalPoint you are searching for

Search the child entity containing point global. Recursively recursively continue until we found an entity that is part of the IndexSet.

Member Data Documentation

◆ dim

template<class Grid , class IS >
constexpr int Dune::HierarchicSearch< Grid, IS >::dim = Grid::dimension
staticprotected

get dimension from the grid

◆ dimw

template<class Grid , class IS >
constexpr int Dune::HierarchicSearch< Grid, IS >::dimw = Grid::dimensionworld
staticprotected

get world dimension from the grid

◆ grid_

template<class Grid , class IS >
const Grid& Dune::HierarchicSearch< Grid, IS >::grid_
protected

◆ indexSet_

template<class Grid , class IS >
const IS& Dune::HierarchicSearch< Grid, IS >::indexSet_
protected

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