Dune Core Modules (unstable)

A set of PartitionType values. More...

#include <dune/grid/common/partitionset.hh>

Public Member Functions

template<unsigned int p>
struct PartitionSet< partitions|p > constexpr operator+ (const PartitionSet< p > &) const
 Returns a new PartitionSet that also contains the partitions in set.
 
template<unsigned int p>
struct PartitionSet< partitions &~p > constexpr operator- (const PartitionSet< p > &) const
 Returns a new PartitionSet that does not contain the partitions in set.
 
template<unsigned int p2>
constexpr bool operator== (PartitionSet< p2 >) const
 Tests whether two PartitionsSet are equal.
 
template<unsigned int p2>
constexpr bool operator!= (PartitionSet< p2 >) const
 Tests whether two PartitionsSet are not equal.
 

Static Public Member Functions

static constexpr PartitionIteratorType partitionIterator ()
 Returns the PartitionIteratorType that can be used to iterate over the partitions in the set. More...
 
static constexpr bool contains (PartitionType pt)
 Tests whether the given PartitionType is contained in this set.
 
template<unsigned int contained_partitions>
static constexpr bool contains (PartitionSet< contained_partitions >)
 Tests whether the given PartitionSet is contained in this set.
 

Related Functions

(Note that these are not member functions.)

template<PartitionType p>
PartitionSet<(1<< p)> partitionSet ()
 Creates a PartitionSet for the given PartitionType.
 
template<PartitionIteratorType pitype>
constexpr PartitionSet< derive_partition_set< pitype >::value > partitionSet ()
 creates a PartitionSet for the given PartitionIteratorType
 

Detailed Description

template<unsigned int partitions>
struct Dune::PartitionSet< partitions >

A set of PartitionType values.

PartitionSet contains a set of PartitionType values fixed at compile time. The contents of the set is encoded in the template parameter partitions, but the exact semantics are an implementation detail. PartitionSets can be combined by adding them up. They also support removing partitions by subtracting them.

Template Parameters
partitionsImplementation-defined representation of the partition set.

Member Function Documentation

◆ partitionIterator()

template<unsigned int partitions>
static constexpr PartitionIteratorType Dune::PartitionSet< partitions >::partitionIterator ( )
inlinestaticconstexpr

Returns the PartitionIteratorType that can be used to iterate over the partitions in the set.

Exceptions
raisesa static assertion if the partitions do not correspond to a valid PartitionIteratorType.

The documentation for this struct was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  generated with Hugo v0.69.0 (Mar 1, 23:27, 2021)