Dune::Fufem::BoundaryData< T > Class Template Reference

Class for storing data associated to boundary segments. More...

#include <dune/fufem/grid/boundarydata.hh>

Public Member Functions
	BoundaryData (const std::vector< T > &data)
	Create BoundaryData.
	BoundaryData (std::vector< T > &&data)
	Create BoundaryData.
template<class Grid >
	BoundaryData (const std::vector< T > &insertedBoundaryData, const Dune::GridFactory< Grid > &factory, const Grid &grid)
	Create BoundaryData.
template<class Grid >
	BoundaryData (const Dune::GmshReader< Grid > &reader, const Dune::GridFactory< Grid > &factory, const Grid &grid)
	Create BoundaryData.
template<class Intersection >
const T &	operator() (const Intersection &intersection) const
	Map intersection to associated data.
const T &	operator[] (std::size_t boundarySegmentIndex) const
	Access data by boundary segment index.
std::size_t	size () const
	Size of the container (number of boundary segments)
const std::vector< T > &	data () const
	Access raw container with stored data.
const std::vector< T > &	coarseData () const
	Access raw container with stored level-0 coarse data.

Detailed Description

template<class T = int>
class Dune::Fufem::BoundaryData< T >

Class for storing data associated to boundary segments.

Template Parameters

T	Type of data associated to segments

This behaves like a random access container that associates data to boundary segments of a grid. The container is indexed using the boundary segment index provided by intersections. The class also provides a function interface mapping boundary intersections directly to the associated data.

This class is intended to be used to extract boundary data from a Dune::GmshReader in a persistent form.

Constructor & Destructor Documentation

BoundaryData() [1/4]

template<class T = int>

Dune::Fufem::BoundaryData< T >::BoundaryData ( const std::vector< T > &  data )

inline

Create BoundaryData.

Parameters

data	A raw vector with the respective data

This constructor requires that the passed data is already ordered with respect to boundary segment indices and will copy this data.

BoundaryData() [2/4]

template<class T = int>

Dune::Fufem::BoundaryData< T >::BoundaryData ( std::vector< T > &&  data )

inline

Create BoundaryData.

Parameters

data	A raw vector with the respective data

This constructor requires that the passed data is already ordered with respect to boundary segment indices and will move this data.

BoundaryData() [3/4]

template<class T = int>

template<class Grid >

Dune::Fufem::BoundaryData< T >::BoundaryData ( const std::vector< T > &  insertedBoundaryData, const Dune::GridFactory< Grid > &  factory, const Grid &  grid  )

inline

Create BoundaryData.

Parameters

insertedBoundaryData	A vector containing boundary data indexed by insertion index
factory	The GridFactory used to create the grid
grid	Grid for which element data should be accessed

This constructor will use the boundary data from the given vector. To permute from the insertion order which is used to index the given vector to the order induced by the boundary-segment-index, this additionally needs the factory that was used to create the grid.

BoundaryData() [4/4]

template<class T = int>

template<class Grid >

Dune::Fufem::BoundaryData< T >::BoundaryData ( const Dune::GmshReader< Grid > &  reader, const Dune::GridFactory< Grid > &  factory, const Grid &  grid  )

inline

Create BoundaryData.

Parameters

reader	A GmshReader to extract the boundary data from
factory	The GridFactory used with the reader to translate insertion indices
grid	Grid for which element data should be accessed

This constructor will extract the boundary data from the given GmshReader. To permute from the insertion order used by the reader to the order induced by the boundary-segment-index, this additionally needs the factory that was used to create the grid.

Member Function Documentation

coarseData()

template<class T = int>

const std::vector< T > & Dune::Fufem::BoundaryData< T >::coarseData ( ) const

inline

Access raw container with stored level-0 coarse data.

Since boundary segment indices are consistent between grid views, this provides the same container as data().

data()

template<class T = int>

const std::vector< T > & Dune::Fufem::BoundaryData< T >::data ( ) const

inline

Access raw container with stored data.

operator()()

template<class T = int>

template<class Intersection >

const T & Dune::Fufem::BoundaryData< T >::operator() ( const Intersection &  intersection ) const

inline

Map intersection to associated data.

operator[]()

template<class T = int>

const T & Dune::Fufem::BoundaryData< T >::operator[] ( std::size_t  boundarySegmentIndex ) const

inline

Access data by boundary segment index.

size()

template<class T = int>

std::size_t Dune::Fufem::BoundaryData< T >::size ( ) const

inline

Size of the container (number of boundary segments)

---

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

• boundarydata.hh