dune-pdelab  2.4-dev
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | List of all members
Dune::PDELab::PowerPermutationOrdering< DI, CI, Child, k > Class Template Reference

Interface for merging index spaces. More...

#include <dune/pdelab/ordering/permutationordering.hh>

Inheritance diagram for Dune::PDELab::PowerPermutationOrdering< DI, CI, Child, k >:
Inheritance graph

Public Types

typedef Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > > This
 
typedef lexicographic_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > > BaseT
 
typedef BaseT::Traits Traits
 
typedef PermutationOrderingTag OrderingTag
 
typedef HierarchicContainerAllocationTag ContainerAllocationTag
 
typedef DefaultLFSCacheTag CacheTag
 

Public Member Functions

 PowerPermutationOrdering (bool container_blocked, const PermutationOrderingTag &ordering_tag, const typename Node::NodeStorage &children)
 Construct ordering object. More...
 
void update ()
 
std::string name () const
 
void map_lfs_indices (const ItIn begin, const ItIn end, ItOut out) const
 
Traits::SizeType extract_entity_indices (const typename Traits::DOFIndex::EntityIndex &ei, typename Traits::SizeType child_index, CIOutIterator ci_out, const CIOutIterator ci_end) const
 
virtual void map_index_dynamic (typename Traits::DOFIndexView di, typename Traits::ContainerIndex &ci) const
 
Traits::ContainerIndex mapIndex (const typename Traits::DOFIndex &di) const
 
void mapIndex (typename Traits::DOFIndexView di, typename Traits::ContainerIndex &ci) const
 
Traits::SizeType size () const
 
Traits::SizeType size (const typename Traits::SizeType child_index) const
 
Traits::SizeType blockCount () const
 
Traits::SizeType sizeOffset (const typename Traits::SizeType child_index) const
 
Traits::SizeType blockOffset (const typename Traits::SizeType child_index) const
 
Traits::SizeType maxLocalSize () const
 
MergeMode::type mergeMode () const
 
bool containerBlocked () const
 
std::size_t childOrderingCount () const
 
OrderingBasechildOrdering (typename Traits::SizeType i)
 
const OrderingBasechildOrdering (typename Traits::SizeType i) const
 
bool contains (typename Traits::SizeType codim) const
 
bool fixedSize (typename Traits::SizeType codim) const
 
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...
 

Public Attributes

bool _fixed_size
 
const bool _container_blocked
 
const MergeMode::type _merge_mode
 
const std::size_t _child_count
 
std::vector< OrderingBase * > _children
 
std::vector< typename Traits::SizeType_child_size_offsets
 
std::vector< typename Traits::SizeType_child_block_offsets
 
std::vector< typename Traits::SizeType_child_block_merge_offsets
 
Traits::CodimFlag _codim_used
 
Traits::CodimFlag _codim_fixed_size
 
std::size_t _max_local_size
 
std::size_t _size
 
std::size_t _block_count
 
const VirtualOrderingBase< DI, CI > * _delegate
 
GFSData_gfs_data
 

Static Public Attributes

static const bool consume_tree_index
 
static const bool has_dynamic_ordering_children = true
 

Protected Types

typedef Dune::PDELab::impl::GridFunctionSpaceOrderingData< typename Traits::SizeTypeGFSData
 

Protected Member Functions

void setDelegate (const VirtualOrderingBase< DI, CI > *delegate)
 Set the delegate called in mapIndex(). More...
 
void _mapIndex (typename Traits::DOFIndexView di, typename Traits::ContainerIndex &ci) const
 
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

template<typename DI, typename CI, typename Child, std::size_t k>
class Dune::PDELab::PowerPermutationOrdering< DI, CI, Child, k >

Interface for merging index spaces.

Member Typedef Documentation

typedef lexicographic_ordering::Base<DI,CI,PowerLexicographicOrdering< DI, CI, Child, k > > Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::BaseT
inherited
template<typename DI, typename CI>
typedef DefaultLFSCacheTag Dune::PDELab::OrderingBase< DI, CI >::CacheTag
inherited
template<typename DI, typename CI>
typedef HierarchicContainerAllocationTag Dune::PDELab::OrderingBase< DI, CI >::ContainerAllocationTag
inherited
template<typename DI, typename CI>
typedef Dune::PDELab::impl::GridFunctionSpaceOrderingData<typename Traits::SizeType> Dune::PDELab::OrderingBase< DI, CI >::GFSData
protectedinherited
typedef Base<DI,CI,PowerLexicographicOrdering< DI, CI, Child, k > > Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::This
inherited

Constructor & Destructor Documentation

template<typename DI , typename CI , typename Child , std::size_t k>
Dune::PDELab::PowerPermutationOrdering< DI, CI, Child, k >::PowerPermutationOrdering ( bool  container_blocked,
const PermutationOrderingTag ordering_tag,
const typename Node::NodeStorage &  children 
)
inline

Construct ordering object.

In general, an ordering object is not properly setup after construction. This must be done by a seperate call to update() after all the children have been properly set up.

Note
This constructor must be present for ordering objects not at the leaf of the tree.

Member Function Documentation

template<typename DI, typename CI>
void Dune::PDELab::OrderingBase< DI, CI >::_mapIndex ( typename Traits::DOFIndexView  di,
typename Traits::ContainerIndex ci 
) const
inlineprotectedinherited
template<typename DI, typename CI>
Traits::SizeType Dune::PDELab::OrderingBase< DI, CI >::blockCount ( ) const
inlineinherited
template<typename DI, typename CI>
Traits::SizeType Dune::PDELab::OrderingBase< DI, CI >::blockOffset ( const typename Traits::SizeType  child_index) const
inlineinherited
template<typename DI, typename CI>
OrderingBase& Dune::PDELab::OrderingBase< DI, CI >::childOrdering ( typename Traits::SizeType  i)
inlineinherited
template<typename DI, typename CI>
const OrderingBase& Dune::PDELab::OrderingBase< DI, CI >::childOrdering ( typename Traits::SizeType  i) const
inlineinherited
template<typename DI, typename CI>
std::size_t Dune::PDELab::OrderingBase< DI, CI >::childOrderingCount ( ) const
inlineinherited
void Dune::PDELab::PartitionInfoProvider::clearPartitionSet ( )
inlineprotectedinherited

Empties the set of contained partitions.

Referenced by Dune::PDELab::PartitionInfoProvider::mergePartitionSets().

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

Returns the internal representation of the set of contained entities.

template<typename DI, typename CI>
bool Dune::PDELab::OrderingBase< DI, CI >::containerBlocked ( ) const
inlineinherited
template<typename DI, typename CI>
bool Dune::PDELab::OrderingBase< DI, CI >::contains ( typename Traits::SizeType  codim) const
inlineinherited
bool Dune::PDELab::PartitionInfoProvider::containsPartition ( PartitionType  partition) const
inlineinherited

Returns whether this ordering contains entities with PartitionType partition.

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

Traits::SizeType Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::extract_entity_indices ( const typename Traits::DOFIndex::EntityIndex &  ei,
typename Traits::SizeType  child_index,
CIOutIterator  ci_out,
const CIOutIterator  ci_end 
) const
inlineinherited
template<typename DI, typename CI>
bool Dune::PDELab::OrderingBase< DI, CI >::fixedSize ( typename Traits::SizeType  codim) const
inlineinherited
virtual void Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::map_index_dynamic ( typename Traits::DOFIndexView  di,
typename Traits::ContainerIndex ci 
) const
inlinevirtualinherited
void Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::map_lfs_indices ( const ItIn  begin,
const ItIn  end,
ItOut  out 
) const
inlineinherited
template<typename DI, typename CI>
Traits::ContainerIndex Dune::PDELab::OrderingBase< DI, CI >::mapIndex ( const typename Traits::DOFIndex di) const
inlineinherited
template<typename DI, typename CI>
void Dune::PDELab::OrderingBase< DI, CI >::mapIndex ( typename Traits::DOFIndexView  di,
typename Traits::ContainerIndex ci 
) const
inlineinherited
template<typename DI, typename CI>
Traits::SizeType Dune::PDELab::OrderingBase< DI, CI >::maxLocalSize ( ) const
inlineinherited
template<typename DI, typename CI>
MergeMode::type Dune::PDELab::OrderingBase< DI, CI >::mergeMode ( ) const
inlineinherited
void Dune::PDELab::PartitionInfoProvider::mergePartitionSet ( const PartitionInfoProvider r)
inlineprotectedinherited

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

Referenced by Dune::PDELab::PartitionInfoProvider::mergePartitionSets().

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

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 Dune::PDELab::PartitionInfoProvider::clearPartitionSet(), and Dune::PDELab::PartitionInfoProvider::mergePartitionSet().

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

template<typename DI , typename CI , typename Child , std::size_t k>
std::string Dune::PDELab::PowerPermutationOrdering< DI, CI, Child, k >::name ( ) const
inline
template<typename DI, typename CI>
void Dune::PDELab::OrderingBase< DI, CI >::setDelegate ( const VirtualOrderingBase< DI, CI > *  delegate)
inlineprotectedinherited

Set the delegate called in mapIndex().

When copying an Ordering with a delegate, the derived Ordering must call this method with 'this' as its argument in the copy and the move constructors!

Referenced by Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::Base().

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

Copies the set of contained partitions from r.

template<typename DI, typename CI>
Traits::SizeType Dune::PDELab::OrderingBase< DI, CI >::size ( ) const
inlineinherited
template<typename DI, typename CI>
Traits::SizeType Dune::PDELab::OrderingBase< DI, CI >::size ( const typename Traits::SizeType  child_index) const
inlineinherited
template<typename DI, typename CI>
Traits::SizeType Dune::PDELab::OrderingBase< DI, CI >::sizeOffset ( const typename Traits::SizeType  child_index) const
inlineinherited
template<typename DI , typename CI , typename Child , std::size_t k>
void Dune::PDELab::PowerPermutationOrdering< DI, CI, Child, k >::update ( )
inline

Member Data Documentation

template<typename DI, typename CI>
std::size_t Dune::PDELab::OrderingBase< DI, CI >::_block_count
inherited
template<typename DI, typename CI>
std::vector<typename Traits::SizeType> Dune::PDELab::OrderingBase< DI, CI >::_child_block_merge_offsets
inherited
template<typename DI, typename CI>
std::vector<typename Traits::SizeType> Dune::PDELab::OrderingBase< DI, CI >::_child_block_offsets
inherited
template<typename DI, typename CI>
const std::size_t Dune::PDELab::OrderingBase< DI, CI >::_child_count
inherited
template<typename DI, typename CI>
std::vector<typename Traits::SizeType> Dune::PDELab::OrderingBase< DI, CI >::_child_size_offsets
inherited
template<typename DI, typename CI>
std::vector<OrderingBase*> Dune::PDELab::OrderingBase< DI, CI >::_children
inherited
template<typename DI, typename CI>
Traits::CodimFlag Dune::PDELab::OrderingBase< DI, CI >::_codim_fixed_size
inherited
template<typename DI, typename CI>
Traits::CodimFlag Dune::PDELab::OrderingBase< DI, CI >::_codim_used
inherited
template<typename DI, typename CI>
const bool Dune::PDELab::OrderingBase< DI, CI >::_container_blocked
inherited
template<typename DI, typename CI>
const VirtualOrderingBase<DI,CI>* Dune::PDELab::OrderingBase< DI, CI >::_delegate
inherited
template<typename DI, typename CI>
bool Dune::PDELab::OrderingBase< DI, CI >::_fixed_size
inherited
template<typename DI, typename CI>
GFSData* Dune::PDELab::OrderingBase< DI, CI >::_gfs_data
inherited
template<typename DI, typename CI>
std::size_t Dune::PDELab::OrderingBase< DI, CI >::_max_local_size
inherited
template<typename DI, typename CI>
const MergeMode::type Dune::PDELab::OrderingBase< DI, CI >::_merge_mode
inherited
template<typename DI, typename CI>
std::size_t Dune::PDELab::OrderingBase< DI, CI >::_size
inherited
const bool Dune::PDELab::permutation_ordering::Base< DI, CI, PowerLexicographicOrdering< DI, CI, Child, k > >::consume_tree_index
staticinherited
template<typename DI, typename CI>
const bool Dune::PDELab::OrderingBase< DI, CI >::has_dynamic_ordering_children = true
staticinherited

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