Entity-wise orderings. More...

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

Inheritance diagram for Dune::PDELab::LocalOrderingBase< ES, DI, CI >:

Public Types
typedef LocalOrderingTraits< ES, DI, CI, MultiIndexOrder::Inner2Outer >	Traits

Public Member Functions
void	map_local_index (const typename Traits::SizeType geometry_type_index, const typename Traits::SizeType entity_index, typename Traits::TreeIndexView mi, typename Traits::ContainerIndex &ci) const

template<typename ItIn , typename ItOut >
void	map_lfs_indices (const ItIn begin, const ItIn end, ItOut out) const
	Set last index of container indices.

template<typename CIOutIterator , typename DIOutIterator = DummyDOFIndexIterator>
Traits::SizeType	extract_entity_indices (const typename Traits::DOFIndex::EntityIndex &ei, typename Traits::SizeType child_index, CIOutIterator ci_out, const CIOutIterator ci_end, DIOutIterator di_out=DIOutIterator()) const

Traits::SizeType	size (const typename Traits::DOFIndex::EntityIndex &index) const

Traits::SizeType	size (const typename Traits::SizeType geometry_type_index, const typename Traits::SizeType entity_index) const

Traits::SizeType	size (const typename Traits::SizeType geometry_type_index, const typename Traits::SizeType entity_index, const typename Traits::SizeType child_index) const

Traits::SizeType	offset (const typename Traits::SizeType geometry_type_index, const typename Traits::SizeType entity_index, const typename Traits::SizeType child_index) const

template<typename Node >
	LocalOrderingBase (Node &node, bool container_blocked, GFSData *gfs_data)

bool	fixedSize () const

bool	contains (const GeometryType &gt) const

bool	contains_geometry_type (typename Traits::SizeType gt_index) const

bool	contains (typename Traits::SizeType codim) const

Traits::SizeType	maxLocalSize () const

Static Public Attributes
static const bool	has_dynamic_ordering_children = true

static const bool	consume_tree_index = true

static constexpr auto	GT_UNUSED = ~std::size_t(0)

Protected Types
typedef impl::GridFunctionSpaceOrderingData< typename Traits::SizeType >	GFSData

Protected Member Functions
template<class Node >
Traits::SizeType	node_size (const Node &node, typename Traits::ContainerIndex suffix, const typename Traits::DOFIndex::EntityIndex &index) const
	Gives the size for a given entity and suffix.

bool	containerBlocked () const

std::size_t	childOrderingCount () const

LocalOrderingBase &	childOrdering (typename Traits::SizeType i)

const LocalOrderingBase &	childOrdering (typename Traits::SizeType i) const

void	disable_container_blocking ()

void	setup_fixed_size_possible ()
	Initial setup of the flag indicating whether a fixed size ordering is possible.

Protected Attributes
bool	_fixed_size

bool	_fixed_size_possible

bool	_container_blocked

std::size_t	_max_local_size

const std::size_t	_child_count

std::vector< LocalOrderingBase * >	_children

Traits::CodimFlag	_codim_used

std::vector< bool >	_gt_used

std::vector< typename Traits::SizeType >	_gt_entity_offsets

std::vector< typename Traits::SizeType >	_gt_dof_offsets

std::vector< typename Traits::SizeType >	_entity_dof_offsets

GFSData *	_gfs_data

Detailed Description

template<typename ES, typename DI, typename CI>
class Dune::PDELab::LocalOrderingBase< ES, DI, CI >

Entity-wise orderings.

A tree structure of this class is able to provide (multi-index) indexations for each entity in an entity set.

Template Parameters

ES	Entity Set
DI	DOFIndex
CI	ContainerIndex

Member Typedef Documentation

◆ GFSData

template<typename ES , typename DI , typename CI >

typedef impl::GridFunctionSpaceOrderingData<typename Traits::SizeType> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::GFSData

protected

◆ Traits

template<typename ES , typename DI , typename CI >

typedef LocalOrderingTraits<ES,DI,CI,MultiIndexOrder::Inner2Outer> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::Traits

Constructor & Destructor Documentation

◆ LocalOrderingBase()

template<typename ES , typename DI , typename CI >

template<typename Node >

Dune::PDELab::LocalOrderingBase< ES, DI, CI >::LocalOrderingBase	(	Node &	node,
		bool	container_blocked,
		GFSData *	gfs_data
	)

inline

Member Function Documentation

◆ childOrdering() [1/2]

template<typename ES , typename DI , typename CI >

LocalOrderingBase & Dune::PDELab::LocalOrderingBase< ES, DI, CI >::childOrdering ( typename Traits::SizeType i )

inlineprotected

◆ childOrdering() [2/2]

template<typename ES , typename DI , typename CI >

const LocalOrderingBase & Dune::PDELab::LocalOrderingBase< ES, DI, CI >::childOrdering ( typename Traits::SizeType i ) const

inlineprotected

◆ childOrderingCount()

template<typename ES , typename DI , typename CI >

std::size_t Dune::PDELab::LocalOrderingBase< ES, DI, CI >::childOrderingCount ( ) const

inlineprotected

◆ containerBlocked()

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::containerBlocked ( ) const

inlineprotected

◆ contains() [1/2]

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::contains ( const GeometryType & gt ) const

inline

◆ contains() [2/2]

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::contains ( typename Traits::SizeType codim ) const

inline

◆ contains_geometry_type()

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::contains_geometry_type ( typename Traits::SizeType gt_index ) const

inline

◆ disable_container_blocking()

template<typename ES , typename DI , typename CI >

void Dune::PDELab::LocalOrderingBase< ES, DI, CI >::disable_container_blocking ( )

inlineprotected

◆ extract_entity_indices()

template<typename ES , typename DI , typename CI >

template<typename CIOutIterator , typename DIOutIterator = DummyDOFIndexIterator>

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::extract_entity_indices	(	const typename Traits::DOFIndex::EntityIndex &	ei,
		typename Traits::SizeType	child_index,
		CIOutIterator	ci_out,
		const CIOutIterator	ci_end,
		DIOutIterator	di_out = `DIOutIterator()`
	)		const

inline

◆ fixedSize()

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::fixedSize ( ) const

inline

◆ map_lfs_indices()

template<typename ES , typename DI , typename CI >

template<typename ItIn , typename ItOut >

void Dune::PDELab::LocalOrderingBase< ES, DI, CI >::map_lfs_indices	(	const ItIn	begin,
		const ItIn	end,
		ItOut	out
	)		const

inline

Set last index of container indices.

For a (view) list of dof indices, this method will fill or append the last index of the same ammount of container indices.

Template Parameters

ItIn	DOFIndexViewIterator<DOFIterator>
ItOut	std::vector<CI>::iterator

Parameters

begin	begin iterator for (view) list of dof indices
end	begin iterator for (view) list of dof indices
out	begin iterator of container indices to be filled out

◆ map_local_index()

template<typename ES , typename DI , typename CI >

void Dune::PDELab::LocalOrderingBase< ES, DI, CI >::map_local_index	(	const typename Traits::SizeType	geometry_type_index,
		const typename Traits::SizeType	entity_index,
		typename Traits::TreeIndexView	mi,
		typename Traits::ContainerIndex &	ci
	)		const

inline

◆ maxLocalSize()

template<typename ES , typename DI , typename CI >

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::maxLocalSize ( ) const

inline

◆ node_size()

template<typename ES , typename DI , typename CI >

template<class Node >

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::node_size	(	const Node &	node,
		typename Traits::ContainerIndex	suffix,
		const typename Traits::DOFIndex::EntityIndex &	index
	)		const

inlineprotected

Gives the size for a given entity and suffix.

This method is used by typetree class derived from this class

Parameters

node	TypeTree version of this class
suffix	MultiIndex with a partial path to a container
index	Entity index to compute the size

Returns: Traits::SizeType The size required for such a path.

◆ offset()

template<typename ES , typename DI , typename CI >

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::offset	(	const typename Traits::SizeType	geometry_type_index,
		const typename Traits::SizeType	entity_index,
		const typename Traits::SizeType	child_index
	)		const

inline

◆ setup_fixed_size_possible()

template<typename ES , typename DI , typename CI >

void Dune::PDELab::LocalOrderingBase< ES, DI, CI >::setup_fixed_size_possible ( )

inlineprotected

Initial setup of the flag indicating whether a fixed size ordering is possible.

For a non-leaf ordering, a fixed size ordering is possible if all children can support it, so we implement that logic here.

Note: Leaf orderings will usually want to extract this a priori information from somewhere else, so they should override this method (the correct method will get called even without a virtual call, as the call happens from a TypeTree visitor that is aware of the precise type of the ordering).

◆ size() [1/3]

template<typename ES , typename DI , typename CI >

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::size ( const typename Traits::DOFIndex::EntityIndex & index ) const

inline

◆ size() [2/3]

template<typename ES , typename DI , typename CI >

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::size	(	const typename Traits::SizeType	geometry_type_index,
		const typename Traits::SizeType	entity_index
	)		const

inline

◆ size() [3/3]

template<typename ES , typename DI , typename CI >

Traits::SizeType Dune::PDELab::LocalOrderingBase< ES, DI, CI >::size	(	const typename Traits::SizeType	geometry_type_index,
		const typename Traits::SizeType	entity_index,
		const typename Traits::SizeType	child_index
	)		const

inline

Member Data Documentation

◆ _child_count

template<typename ES , typename DI , typename CI >

const std::size_t Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_child_count

protected

◆ _children

template<typename ES , typename DI , typename CI >

std::vector<LocalOrderingBase*> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_children

protected

◆ _codim_used

template<typename ES , typename DI , typename CI >

Traits::CodimFlag Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_codim_used

protected

◆ _container_blocked

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_container_blocked

protected

◆ _entity_dof_offsets

template<typename ES , typename DI , typename CI >

std::vector<typename Traits::SizeType> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_entity_dof_offsets

protected

◆ _fixed_size

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_fixed_size

protected

◆ _fixed_size_possible

template<typename ES , typename DI , typename CI >

bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_fixed_size_possible

protected

◆ _gfs_data

template<typename ES , typename DI , typename CI >

GFSData* Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_gfs_data

protected

◆ _gt_dof_offsets

template<typename ES , typename DI , typename CI >

std::vector<typename Traits::SizeType> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_gt_dof_offsets

protected

◆ _gt_entity_offsets

template<typename ES , typename DI , typename CI >

std::vector<typename Traits::SizeType> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_gt_entity_offsets

protected

◆ _gt_used

template<typename ES , typename DI , typename CI >

std::vector<bool> Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_gt_used

protected

◆ _max_local_size

template<typename ES , typename DI , typename CI >

std::size_t Dune::PDELab::LocalOrderingBase< ES, DI, CI >::_max_local_size

protected

◆ consume_tree_index

template<typename ES , typename DI , typename CI >

const bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::consume_tree_index = true

static

◆ GT_UNUSED

template<typename ES , typename DI , typename CI >

constexpr auto Dune::PDELab::LocalOrderingBase< ES, DI, CI >::GT_UNUSED = ~std::size_t(0)

staticconstexpr

◆ has_dynamic_ordering_children

template<typename ES , typename DI , typename CI >

const bool Dune::PDELab::LocalOrderingBase< ES, DI, CI >::has_dynamic_ordering_children = true

static

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

localorderingbase.hh

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ GFSData

◆ Traits

Constructor & Destructor Documentation

◆ LocalOrderingBase()

Member Function Documentation

◆ childOrdering() [1/2]

◆ childOrdering() [2/2]

◆ childOrderingCount()

◆ containerBlocked()

◆ contains() [1/2]

◆ contains() [2/2]

◆ contains_geometry_type()

◆ disable_container_blocking()

◆ extract_entity_indices()

◆ fixedSize()

◆ map_lfs_indices()

◆ map_local_index()

◆ maxLocalSize()

◆ node_size()

◆ offset()

◆ setup_fixed_size_possible()

◆ size() [1/3]

◆ size() [2/3]

◆ size() [3/3]

Member Data Documentation

◆ _child_count

◆ _children

◆ _codim_used

◆ _container_blocked

◆ _entity_dof_offsets

◆ _fixed_size

◆ _fixed_size_possible

◆ _gfs_data

◆ _gt_dof_offsets

◆ _gt_entity_offsets

◆ _gt_used

◆ _max_local_size

◆ consume_tree_index

◆ GT_UNUSED

◆ has_dynamic_ordering_children