dune-pdelab  2.0.0
Public Member Functions | Protected Member Functions | List of all members
Dune::PDELab::PartitionInfoProvider Class Reference

Mixin class for providing information about contained grid partitions. More...

#include <dune/pdelab/common/partitioninfoprovider.hh>

Inheritance diagram for Dune::PDELab::PartitionInfoProvider:
Inheritance graph

Public Member Functions

bool containsPartition (PartitionType partition) const
 Returns whether this ordering contains entities with PartitionType partition. More...
 
std::bitset< 6 > containedPartitions () const
 Returns the internal representation of the set of contained entities. More...
 

Protected Member Functions

void clearPartitionSet ()
 Empties the set of contained partitions. More...
 
void mergePartitionSet (const PartitionInfoProvider &r)
 Adds all partitions contained in r the set of contained partitions. More...
 
void setPartitionSet (const std::bitset< 6 > &partitions)
 Sets the set of contained partitions to the passed-in value. More...
 
void setPartitionSet (const PartitionInfoProvider &r)
 Copies the set of contained partitions from r. More...
 
template<typename It >
void mergePartitionSets (It begin, It end)
 Adds the partitions from all PartitionInfoProviders in the range [begin,end). More...
 

Detailed Description

Mixin class for providing information about contained grid partitions.

This is a mixin class for orderings providing the common implementation of the Dune::PartitionType query interface. As the number of partition types is fixed, we can easily move the complete implementation into this mixin, only requiring the ordering to update the contained information using the protected API.

Member Function Documentation

void Dune::PDELab::PartitionInfoProvider::clearPartitionSet ( )
inlineprotected

Empties the set of contained partitions.

Referenced by mergePartitionSets().

std::bitset<6> Dune::PDELab::PartitionInfoProvider::containedPartitions ( ) const
inline

Returns the internal representation of the set of contained entities.

bool Dune::PDELab::PartitionInfoProvider::containsPartition ( PartitionType  partition) const
inline

Returns whether this ordering contains entities with PartitionType partition.

Referenced by Dune::PDELab::GridFunctionSpaceBase< GridFunctionSpace, PowerCompositeGridFunctionSpaceTraits< GV, B, O, k > >::containsPartition().

void Dune::PDELab::PartitionInfoProvider::mergePartitionSet ( const PartitionInfoProvider r)
inlineprotected

Adds all partitions contained in r the set of contained partitions.

Referenced by mergePartitionSets().

template<typename It >
void Dune::PDELab::PartitionInfoProvider::mergePartitionSets ( It  begin,
It  end 
)
inlineprotected

Adds the partitions from all PartitionInfoProviders in the range [begin,end).

Note
The passed-in iterators may yield both references and pointers to the PartitionInfoProviders in the range. This feature exists mostly to simplify implementation of the dynamic ordering base classes, which hold pointers to their children.

References clearPartitionSet(), and mergePartitionSet().

Referenced by Dune::PDELab::LocalOrderingBase< DUNE_TYPETREE_COMPOSITENODE_FIRST_CHILD::Traits::GridView, DUNE_TYPETREE_COMPOSITENODE_FIRST_CHILD::Traits::DOFIndex, DUNE_TYPETREE_COMPOSITENODE_FIRST_CHILD::Traits::ContainerIndex >::LocalOrderingBase(), and Dune::PDELab::OrderingBase< Ordering::Traits::DOFIndex, Ordering::Traits::ContainerIndex >::OrderingBase().

void Dune::PDELab::PartitionInfoProvider::setPartitionSet ( const std::bitset< 6 > &  partitions)
inlineprotected
void Dune::PDELab::PartitionInfoProvider::setPartitionSet ( const PartitionInfoProvider r)
inlineprotected

Copies the set of contained partitions from r.


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