Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod > Class Template Reference

A class representing the sparse mapping of entity relations (e.g. vertices of faces). More...

#include <GridHelpers.hpp>

Inheritance diagram for Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod >:
Inheritance graph

Public Types

typedef LocalIndexProxy< AccessMethod, SizeMethod > row_type
 

Public Member Functions

 LocalIndexContainerProxy (const Dune::CpGrid *grid)
 Constructor. More...
 
row_type operator[] (int cell_index) const
 Get the mapping for a cell. More...
 
int operator() (int cell_index, int local_index) const
 Get a face associated with a cell. More...
 

Detailed Description

template<int(Dune::CpGrid::*)(int, int) const AccessMethod, int(Dune::CpGrid::*)(int) const SizeMethod>
class Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod >

A class representing the sparse mapping of entity relations (e.g. vertices of faces).

Template Parameters
AccessMethodFunction pointer to access the values of a sparse row (e.g. the vertices attached to a face.
SizeMethodFuction pointer to access the size of the sparse row (e.g. the number of vertices attached to a face.

Member Typedef Documentation

◆ row_type

template<int(Dune::CpGrid::*)(int, int) const AccessMethod, int(Dune::CpGrid::*)(int) const SizeMethod>
typedef LocalIndexProxy<AccessMethod, SizeMethod> Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod >::row_type

Constructor & Destructor Documentation

◆ LocalIndexContainerProxy()

template<int(Dune::CpGrid::*)(int, int) const AccessMethod, int(Dune::CpGrid::*)(int) const SizeMethod>
Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod >::LocalIndexContainerProxy ( const Dune::CpGrid grid)
inlineexplicit

Constructor.

Parameters
gridThe grid whose information we represent.

Member Function Documentation

◆ operator()()

template<int(Dune::CpGrid::*)(int, int) const AccessMethod, int(Dune::CpGrid::*)(int) const SizeMethod>
int Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod >::operator() ( int  cell_index,
int  local_index 
) const
inline

Get a face associated with a cell.

Parameters
cell_indexThe index of the cell.
local_indexThe local index of the cell, either 0 or 1.
Theindex of the face or -1 if it is not present because of a boundary.

◆ operator[]()

template<int(Dune::CpGrid::*)(int, int) const AccessMethod, int(Dune::CpGrid::*)(int) const SizeMethod>
row_type Dune::cpgrid::LocalIndexContainerProxy< AccessMethod, SizeMethod >::operator[] ( int  cell_index) const
inline

Get the mapping for a cell.

Parameters
cell_indexThe index of the cell.

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