dune-fem 2.8.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Public Attributes | 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 <dune/fem/gridpart/filteredgridpart.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
 
typedef FilterImp FilterType
 type of filter
 
typedef Traits::HostGridPartType HostGridPartType
 
typedef Traits::GridType GridType
 grid type
 
typedef Traits::IndexSetType IndexSetType
 index set type
 
typedef Traits::IntersectionIteratorType IntersectionIteratorType
 intersection iterator type
 
typedef IntersectionIteratorType::Intersection IntersectionType
 intersection type
 
typedef Traits::CollectiveCommunicationType CollectiveCommunicationType
 
typedef AddGridViewType::GridViewType GridViewType
 
typedef Traits::GridPartType GridPartType
 Type of the implementation.
 
typedef Traits::TwistUtilityType TwistUtilityType
 Twist utility type.
 
typedef GridType::ctype ctype
 
typedef TraitsImp::GridPartType GridPartType
 

Public Member Functions

 FilteredGridPart (HostGridPartType &hostGridPart, const FilterType &filter)
 constructor
 
 FilteredGridPart (HostGridPartType &hostGridPart, const FilterType &filter, const GridViewType *gridView)
 
 FilteredGridPart (const FilteredGridPart &other)
 copy constructor
 
const GridTypegrid () const
 return const reference to underlying grid
 
GridTypegrid ()
 return reference to underlying grid
 
const IndexSetTypeindexSet () const
 return index set of this grid part
 
template<int codim>
Codim< codim >::IteratorType begin () const
 Begin iterator on the leaf level.
 
template<int codim, PartitionIteratorType pitype>
Codim< codim >::template Partition< pitype >::IteratorType begin () const
 Begin iterator on the leaf level.
 
template<int codim>
Codim< codim >::IteratorType end () const
 Begin iterator on the leaf level.
 
template<int codim, PartitionIteratorType pitype>
Codim< codim >::template Partition< pitype >::IteratorType end () const
 End iterator on the leaf level.
 
int level () const
 Returns maxlevel of the grid.
 
IntersectionIteratorType ibegin (const EntityType &entity) const
 ibegin of corresponding intersection iterator for given entity
 
IntersectionIteratorType iend (const EntityType &entity) const
 iend of corresponding intersection iterator for given entity
 
int boundaryId (const IntersectionType &intersection) const
 boundary id
 
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
 
template<class EntitySeed >
Codim< EntitySeed::codimension >::EntityType entity (const EntitySeed &seed) const
 obtain entity pointer from entity seed
 
const FilterTypefilter () const
 return reference to filter
 
FilterTypefilter ()
 return reference to filter
 
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.
 
IntersectionIteratorType ibegin (const typename Codim< 0 >::EntityType &entity) const
 ibegin of corresponding intersection iterator for given entity
 
IntersectionIteratorType iend (const typename Codim< 0 >::EntityType &entity) const
 iend of corresponding intersection iterator for given entity
 
int sequence () const
 return sequence number to update structures depending on the grid part
 
const GridViewTypegridView () const
 

Public Attributes

std::shared_ptr< GridViewTypegridViewStorage_
 
const GridViewTypegridView_
 

Static Public Attributes

static const PartitionIteratorType indexSetPartitionType
 Maximum Partition type, the index set provides indices for.
 
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

◆ CollectiveCommunicationType

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

◆ ctype

typedef GridType::ctype Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::ctype
inherited

◆ FilterType

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

type of filter

◆ GridPartType [1/2]

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

Type of the implementation.

◆ GridPartType [2/2]

typedef TraitsImp::GridPartType Dune::Fem::AddGridView< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::GridPartType
inherited

◆ GridType

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

grid type

◆ GridViewType

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

◆ HostGridPartType

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

◆ IndexSetType

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

index set type

◆ IntersectionIteratorType

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

intersection iterator type

◆ IntersectionType

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

intersection type

◆ Traits

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

traits class

◆ TwistUtilityType

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

Twist utility type.

Constructor & Destructor Documentation

◆ FilteredGridPart() [1/3]

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

constructor

◆ FilteredGridPart() [2/3]

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

◆ FilteredGridPart() [3/3]

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

◆ begin() [1/2]

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.

◆ begin() [2/2]

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.

◆ boundaryId()

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

boundary id

◆ comm()

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

◆ communicate()

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

◆ contains()

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

◆ convert()

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.

◆ end() [1/2]

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.

◆ end() [2/2]

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.

◆ entity()

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

◆ filter() [1/2]

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

return reference to filter

◆ filter() [2/2]

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

return reference to filter

◆ grid() [1/2]

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

return reference to underlying grid

◆ grid() [2/2]

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

return const reference to underlying grid

◆ gridView()

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

◆ hostGridPart() [1/2]

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

◆ hostGridPart() [2/2]

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

◆ ibegin() [1/2]

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

◆ ibegin() [2/2]

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

◆ iend() [1/2]

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

◆ iend() [2/2]

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

◆ indexSet()

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

◆ level()

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

Returns maxlevel of the grid.

◆ sequence()

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

◆ dimension

const int Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::dimension
staticinherited

◆ dimensionworld

const int Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::dimensionworld
staticinherited

◆ gridView_

const GridViewType* Dune::Fem::AddGridView< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::gridView_
inherited

◆ gridViewStorage_

std::shared_ptr<GridViewType> Dune::Fem::AddGridView< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::gridViewStorage_
inherited

◆ indexSetInterfaceType

const InterfaceType Dune::Fem::GridPartInterface< FilteredGridPartTraits< HostGridPartImp, FilterImp, useFilteredIndexSet > >::indexSetInterfaceType
staticinherited

◆ indexSetPartitionType

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 file: