dune-fem 2.8.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil > Class Template Reference

a simple wrapper class for sparsity patterns provide as vector< set< size_t > > More...

#include <dune/fem/operator/common/stencil.hh>

Classes

struct  Iterator
 

Public Types

typedef StencilType::DomainEntityType DomainEntityType
 
typedef StencilType::RangeEntityType RangeEntityType
 
typedef StencilType::DomainGlobalKeyType DomainGlobalKeyType
 
typedef StencilType::RangeGlobalKeyType RangeGlobalKeyType
 
typedef LocalStencil LocalStencilType
 
typedef std::vector< LocalStencilTypeGlobalStencilType
 

Public Member Functions

 StencilWrapper (const GlobalStencilType &stencil)
 
int maxNonZerosEstimate () const
 
const LocalStencilTypelocalStencil (const DomainGlobalKeyType &key) const
 
const ThisTypeglobalStencil () const
 
void fill (const DomainEntityType &dEntity, const RangeEntityType &rEntity, bool fillGhost=true)
 Create stencil entries for (dEntity,rEntity) pair.
 
Iterator begin () const
 
Iterator end () const
 
Iterator find (const DomainGlobalKeyType &key) const
 

Protected Member Functions

int computeMaxNZ () const
 

Protected Attributes

const GlobalStencilTypestencil_
 
int maxNZ_
 

Detailed Description

template<class DomainSpace, class RangeSpace, class LocalStencil>
class Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >

a simple wrapper class for sparsity patterns provide as vector< set< size_t > >

Template Parameters
DomainSpacetype of discrete function space for the domain
RangeSpacetype of discrete function space for the range

Member Typedef Documentation

◆ DomainEntityType

template<class DomainSpace , class RangeSpace , class LocalStencil >
typedef StencilType::DomainEntityType Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::DomainEntityType

◆ DomainGlobalKeyType

template<class DomainSpace , class RangeSpace , class LocalStencil >
typedef StencilType::DomainGlobalKeyType Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::DomainGlobalKeyType

◆ GlobalStencilType

template<class DomainSpace , class RangeSpace , class LocalStencil >
typedef std::vector< LocalStencilType > Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::GlobalStencilType

◆ LocalStencilType

template<class DomainSpace , class RangeSpace , class LocalStencil >
typedef LocalStencil Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::LocalStencilType

◆ RangeEntityType

template<class DomainSpace , class RangeSpace , class LocalStencil >
typedef StencilType::RangeEntityType Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::RangeEntityType

◆ RangeGlobalKeyType

template<class DomainSpace , class RangeSpace , class LocalStencil >
typedef StencilType::RangeGlobalKeyType Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::RangeGlobalKeyType

Constructor & Destructor Documentation

◆ StencilWrapper()

template<class DomainSpace , class RangeSpace , class LocalStencil >
Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::StencilWrapper ( const GlobalStencilType stencil)
inline

Member Function Documentation

◆ begin()

template<class DomainSpace , class RangeSpace , class LocalStencil >
Iterator Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::begin ( ) const
inline

◆ computeMaxNZ()

template<class DomainSpace , class RangeSpace , class LocalStencil >
int Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::computeMaxNZ ( ) const
inlineprotected

◆ end()

template<class DomainSpace , class RangeSpace , class LocalStencil >
Iterator Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::end ( ) const
inline

◆ fill()

template<class DomainSpace , class RangeSpace , class LocalStencil >
void Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::fill ( const DomainEntityType dEntity,
const RangeEntityType rEntity,
bool  fillGhost = true 
)
inline

Create stencil entries for (dEntity,rEntity) pair.

Parameters
[in]dEntitydomain entity
[in]rEntityrange entity
[in]fillGhostsetup stencil even for a ghost domain entity

◆ find()

template<class DomainSpace , class RangeSpace , class LocalStencil >
Iterator Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::find ( const DomainGlobalKeyType key) const
inline

◆ globalStencil()

template<class DomainSpace , class RangeSpace , class LocalStencil >
const ThisType & Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::globalStencil ( ) const
inline

◆ localStencil()

template<class DomainSpace , class RangeSpace , class LocalStencil >
const LocalStencilType & Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::localStencil ( const DomainGlobalKeyType key) const
inline

◆ maxNonZerosEstimate()

template<class DomainSpace , class RangeSpace , class LocalStencil >
int Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::maxNonZerosEstimate ( ) const
inline

Member Data Documentation

◆ maxNZ_

template<class DomainSpace , class RangeSpace , class LocalStencil >
int Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::maxNZ_
protected

◆ stencil_

template<class DomainSpace , class RangeSpace , class LocalStencil >
const GlobalStencilType& Dune::Fem::StencilWrapper< DomainSpace, RangeSpace, LocalStencil >::stencil_
protected

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