dune-fem  2.4.1-rc
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet > Class Template Reference

A FilteredGridPart allows to extract a set of entities from a grid satisfying a given constrainted defined through a filter class. More...

#include </local/tomalk/somewhere/tmp/dune-fem/dune/fem/gridpart/filteredgridpart/capabilities.hh>

Inheritance diagram for Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >:
Inheritance graph

Classes

struct  Codim
 grid part typedefs, use those of traits More...
 

Public Types

typedef FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > Traits
 traits class More...
 
typedef FilterImp FilterType
 type of filter More...
 
typedef Traits::HostGridPartType HostGridPartType
 
typedef Traits::GridType GridType
 grid type More...
 
typedef Traits::IndexSetType IndexSetType
 index set type More...
 
typedef Traits::IntersectionIteratorType IntersectionIteratorType
 intersection iterator type More...
 
typedef IntersectionIteratorType::Intersection IntersectionType
 intersection type More...
 
typedef Traits::CollectiveCommunicationType CollectiveCommunicationType
 
typedef Traits::GridPartType GridPartType
 Type of the implementation. More...
 
typedef Traits::TwistUtilityType TwistUtilityType
 Twist utility type. More...
 
typedef PoliciesType::GridViewType GridViewType
 
typedef GridType::ctype ctype
 

Public Member Functions

 FilteredGridPart (HostGridPartType &hostGridPart, const FilterType &filter)
 constructor More...
 
 ~FilteredGridPart ()
 destructor More...
 
 FilteredGridPart (const FilteredGridPart &other)
 copy constructor More...
 
const GridTypegrid () const
 return const reference to underlying grid More...
 
GridTypegrid ()
 return reference to underlying grid More...
 
const IndexSetTypeindexSet () const
 return index set of this grid part More...
 
template<int codim>
Codim< codim >::IteratorType begin () const
 Begin iterator on the leaf level. More...
 
template<int codim, PartitionIteratorType pitype>
Codim< codim >::template Partition< pitype >::IteratorType begin () const
 Begin iterator on the leaf level. More...
 
template<int codim>
Codim< codim >::IteratorType end () const
 Begin iterator on the leaf level. More...
 
template<int codim, PartitionIteratorType pitype>
Codim< codim >::template Partition< pitype >::IteratorType end () const
 End iterator on the leaf level. More...
 
int level () const
 Returns maxlevel of the grid. More...
 
IntersectionIteratorType ibegin (const EntityType &entity) const
 ibegin of corresponding intersection iterator for given entity More...
 
IntersectionIteratorType iend (const EntityType &entity) const
 iend of corresponding intersection iterator for given entity More...
 
int boundaryId (const IntersectionType &intersection) const
 
const CollectiveCommunicationTypecomm () const
 
template<class DataHandleImp , class DataType >
void communicate (CommDataHandleIF< DataHandleImp, DataType > &dataHandle, InterfaceType iftype, CommunicationDirection dir) const
 corresponding communication method for this grid part More...
 
template<class EntitySeed >
Codim< EntitySeed::codimension >::EntityType entity (const EntitySeed &seed) const
 obtain entity pointer from entity seed More...
 
const FilterTypefilter () const
 return reference to filter More...
 
FilterTypefilter ()
 return reference to filter More...
 
template<class Entity >
bool contains (const Entity &entity) const
 
HostGridPartTypehostGridPart ()
 
const HostGridPartTypehostGridPart () const
 
template<class Entity >
const Entity & convert (const Entity &entity) const
 convert the grid's entity to a grid part entity Usually the parameter is GridType :: Codim< codim > :: Entity and the return is Codim< codim > :: EntityType. In general these types are the same, but for overloaded entities on grid parts this can differ. More...
 
GridViewType gridView () const
 convert grid part into a dune grid view More...
 
IntersectionIteratorType ibegin (const typename Codim< 0 >::EntityType &entity) const
 ibegin of corresponding intersection iterator for given entity More...
 
IntersectionIteratorType iend (const typename Codim< 0 >::EntityType &entity) const
 iend of corresponding intersection iterator for given entity More...
 
int sequence () const
 return sequence number to update structures depending on the grid part More...
 

Static Public Attributes

static const PartitionIteratorType indexSetPartitionType
 Maximum Partition type, the index set provides indices for. More...
 
static const InterfaceType indexSetInterfaceType
 
static const int dimension
 
static const int dimensionworld
 

Detailed Description

template<class HostGridPartImp, class FilterImp, bool useFilteredIndexSet>
class Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >

A FilteredGridPart allows to extract a set of entities from a grid satisfying a given constrainted defined through a filter class.

Member Typedef Documentation

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef Traits::CollectiveCommunicationType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::CollectiveCommunicationType
typedef GridType::ctype Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::ctype
inherited
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef FilterImp Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::FilterType

type of filter

typedef Traits::GridPartType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::GridPartType
inherited

Type of the implementation.

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef Traits::GridType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::GridType

grid type

typedef PoliciesType::GridViewType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::GridViewType
inherited
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef Traits::HostGridPartType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::HostGridPartType
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef Traits::IndexSetType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::IndexSetType

index set type

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef Traits:: IntersectionIteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::IntersectionIteratorType

intersection iterator type

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef IntersectionIteratorType::Intersection Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::IntersectionType

intersection type

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
typedef FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::Traits

traits class

typedef Traits::TwistUtilityType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::TwistUtilityType
inherited

Twist utility type.

Constructor & Destructor Documentation

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::FilteredGridPart ( HostGridPartType hostGridPart,
const FilterType filter 
)
inline

constructor

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::~FilteredGridPart ( )
inline

destructor

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::FilteredGridPart ( const FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet > &  other)
inline

copy constructor

Member Function Documentation

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<int codim>
Codim< codim >::IteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::begin ( ) const
inline

Begin iterator on the leaf level.

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<int codim, PartitionIteratorType pitype>
Codim< codim >::template Partition< pitype >::IteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::begin ( ) const
inline

Begin iterator on the leaf level.

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
int Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::boundaryId ( const IntersectionType intersection) const
inline
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
const CollectiveCommunicationType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::comm ( ) const
inline
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<class DataHandleImp , class DataType >
void Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::communicate ( CommDataHandleIF< DataHandleImp, DataType > &  dataHandle,
InterfaceType  iftype,
CommunicationDirection  dir 
) const
inline

corresponding communication method for this grid part

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<class Entity >
bool Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::contains ( const Entity &  entity) const
inline
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<class Entity >
const Entity& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::convert ( const Entity &  entity) const
inline

convert the grid's entity to a grid part entity Usually the parameter is GridType :: Codim< codim > :: Entity and the return is Codim< codim > :: EntityType. In general these types are the same, but for overloaded entities on grid parts this can differ.

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<int codim>
Codim< codim >::IteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::end ( ) const
inline

Begin iterator on the leaf level.

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<int codim, PartitionIteratorType pitype>
Codim< codim >::template Partition< pitype >::IteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::end ( ) const
inline

End iterator on the leaf level.

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
template<class EntitySeed >
Codim< EntitySeed::codimension >::EntityType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::entity ( const EntitySeed &  seed) const
inline

obtain entity pointer from entity seed

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
const FilterType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::filter ( ) const
inline

return reference to filter

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
FilterType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::filter ( )
inline

return reference to filter

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
const GridType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::grid ( ) const
inline

return const reference to underlying grid

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
GridType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::grid ( )
inline

return reference to underlying grid

GridViewType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::gridView ( ) const
inlineinherited

convert grid part into a dune grid view

Deprecated:
"gridPart.gridView() is deprecated, use direct cast to GridPart::GridViewType instead"
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
HostGridPartType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::hostGridPart ( )
inline
template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
const HostGridPartType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::hostGridPart ( ) const
inline
IntersectionIteratorType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::ibegin ( const typename Codim< 0 >::EntityType &  entity) const
inlineinherited

ibegin of corresponding intersection iterator for given entity

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
IntersectionIteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::ibegin ( const EntityType &  entity) const
inline

ibegin of corresponding intersection iterator for given entity

IntersectionIteratorType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::iend ( const typename Codim< 0 >::EntityType &  entity) const
inlineinherited

iend of corresponding intersection iterator for given entity

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
IntersectionIteratorType Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::iend ( const EntityType &  entity) const
inline

iend of corresponding intersection iterator for given entity

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
const IndexSetType& Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::indexSet ( ) const
inline

return index set of this grid part

template<class HostGridPartImp , class FilterImp , bool useFilteredIndexSet>
int Dune::Fem::FilteredGridPart< HostGridPartImp, FilterImp, useFilteredIndexSet >::level ( ) const
inline

Returns maxlevel of the grid.

int Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::sequence ( ) const
inlineinherited

return sequence number to update structures depending on the grid part

Note
The default returns DofManager< Grid > :: sequence ()

Member Data Documentation

const int Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::dimension
staticinherited
const int Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::dimensionworld
staticinherited
const InterfaceType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::indexSetInterfaceType
staticinherited
const PartitionIteratorType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::indexSetPartitionType
staticinherited

Maximum Partition type, the index set provides indices for.


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