A Vector of blocks with different blocksizes. More...

#include <dune/istl/vbvector.hh>

Classes
class	ConstIterator
	ConstIterator class for sequential access. More...

class	CreateIterator
	Iterator class for sequential creation of blocks. More...

class	Iterator
	Iterator class for sequential access. More...

Public Types
enum	{ blocklevel = B::blocklevel+2 }

typedef B::field_type	field_type
	export the type representing the field

typedef A	allocator_type
	export the allocator type

typedef A::size_type	size_type
	The size type for the index access.

typedef BlockVector< B, A >	block_type

typedef base_array_unmanaged< B, std::allocator< B > >::iterator	Iterator
	make iterators available as types

typedef base_array_unmanaged< B, std::allocator< B > >::const_iterator	ConstIterator
	make iterators available as types

typedef B	value_type
	for STL compatibility

typedef B	member_type
	export the type representing the components

typedef RealIterator< B >	iterator
	iterator type for sequential access

typedef RealIterator< const B >	const_iterator
	iterator class for sequential access

Public Member Functions
	VariableBlockVector ()

	VariableBlockVector (size_type _nblocks)

	VariableBlockVector (size_type _nblocks, size_type m)

	VariableBlockVector (const VariableBlockVector &a)
	copy constructor, has copy semantics

	~VariableBlockVector ()
	free dynamic memory

void	resize (size_type _nblocks)
	same effect as constructor with same argument

void	resize (size_type _nblocks, size_type m)
	same effect as constructor with same argument

VariableBlockVector &	operator= (const VariableBlockVector &a)
	assignment

VariableBlockVector &	operator= (const field_type &k)
	assign from scalar

CreateIterator	createbegin ()
	get initial create iterator

CreateIterator	createend ()
	get create iterator pointing to one after the last block

window_type &	operator[] (size_type i)
	random access to blocks

const window_type &	operator[] (size_type i) const
	same for read only access

Iterator	begin ()
	begin Iterator

Iterator	end ()
	end Iterator

Iterator	beforeEnd ()

Iterator	beforeBegin () const

Iterator	find (size_type i)
	random access returning iterator (end if not contained)

ConstIterator	find (size_type i) const
	random access returning iterator (end if not contained)

ConstIterator	begin () const
	begin ConstIterator

ConstIterator	end () const
	end ConstIterator

ConstIterator	beforeEnd () const

ConstIterator	rend () const
	end ConstIterator

size_type	N () const
	number of blocks in the vector (are of variable size here)

block_vector_unmanaged &	operator+= (const block_vector_unmanaged &y)
	vector space addition

block_vector_unmanaged &	operator-= (const block_vector_unmanaged &y)
	vector space subtraction

block_vector_unmanaged &	*operator=** (const field_type &k)
	vector space multiplication with scalar

block_vector_unmanaged &	operator/= (const field_type &k)
	vector space division by scalar

block_vector_unmanaged &	axpy (const field_type &a, const block_vector_unmanaged &y)
	vector space axpy operation

PromotionTraits< field_type, typenameOtherB::field_type >::PromotedType	operator* (const block_vector_unmanaged< OtherB, OtherA > &y) const
	indefinite vector dot product \(\left (x^T \cdot y \right)\) which corresponds to Petsc's VecTDot More...

PromotionTraits< field_type, typenameOtherB::field_type >::PromotedType	dot (const block_vector_unmanaged< OtherB, OtherA > &y) const
	vector dot product \(\left (x^H \cdot y \right)\) which corresponds to Petsc's VecDot More...

FieldTraits< field_type >::real_type	one_norm () const
	one norm (sum over absolute values of entries)

FieldTraits< field_type >::real_type	one_norm_real () const
	simplified one norm (uses Manhattan norm for complex values)

FieldTraits< field_type >::real_type	two_norm () const
	two norm sqrt(sum over squared values of entries)

FieldTraits< field_type >::real_type	two_norm2 () const
	Square of the two-norm (the sum over the squared values of the entries)

FieldTraits< field_type >::real_type	infinity_norm () const
	infinity norm (maximum of absolute values of entries)

FieldTraits< field_type >::real_type	infinity_norm_real () const
	simplified infinity norm (uses Manhattan norm for complex values)

size_type	dim () const
	dimension of the vector space

iterator	beforeBegin ()

size_type	size () const
	number of blocks in the array (are of size 1 here)

Detailed Description

template<class B, class A = std::allocator>
class Dune::VariableBlockVector< B, A >

A Vector of blocks with different blocksizes.

implements a vector consisting of a number of blocks (to
be given at run-time) which themselves consist of a number
of blocks (also given at run-time) of the given type B.

VariableBlockVector is a container of containers!

Member Typedef Documentation

◆ block_type

template<class B , class A = std::allocator>

typedef BlockVector<B,A> Dune::VariableBlockVector< B, A >::block_type

export the type representing the components, note that this is not the type refered to by the iterators and random access. However, it can be used to copy blocks (which is its only purpose).

Member Enumeration Documentation

◆ anonymous enum

template<class B , class A = std::allocator>

anonymous enum

increment block level counter, yes, it is two levels because VariableBlockVector is a container of containers

Enumerator
blocklevel	The number of blocklevels this vector contains.

Constructor & Destructor Documentation

◆ VariableBlockVector() [1/3]

template<class B , class A = std::allocator>

Dune::VariableBlockVector< B, A >::VariableBlockVector ( )

inline

constructor without arguments makes empty vector, object cannot be used yet

◆ VariableBlockVector() [2/3]

template<class B , class A = std::allocator>

Dune::VariableBlockVector< B, A >::VariableBlockVector ( size_type _nblocks )

inlineexplicit

make vector with given number of blocks, but size of each block is not yet known, object cannot be used yet

◆ VariableBlockVector() [3/3]

template<class B , class A = std::allocator>

Dune::VariableBlockVector< B, A >::VariableBlockVector	(	size_type	_nblocks,
		size_type	m
	)

inline

make vector with given number of blocks each having a constant size, object is fully usable then.

Parameters

_nblocks	Number of blocks
m	Number of elements in each block

Member Function Documentation

◆ beforeBegin() [1/2]

iterator Dune::base_array_unmanaged< B, std::allocator >::beforeBegin ( )

inlineinherited

Returns: an iterator that is positioned before the first entry of the vector.

◆ beforeBegin() [2/2]

template<class B , class A = std::allocator>

Iterator Dune::VariableBlockVector< B, A >::beforeBegin ( ) const

inline

Returns: an iterator that is positioned before the first entry of the vector.

◆ beforeEnd() [1/2]

template<class B , class A = std::allocator>

Iterator Dune::VariableBlockVector< B, A >::beforeEnd ( )

inline

Returns: an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.

◆ beforeEnd() [2/2]

template<class B , class A = std::allocator>

ConstIterator Dune::VariableBlockVector< B, A >::beforeEnd ( ) const

inline

Returns: an iterator that is positioned before the end iterator of the vector. i.e. at the last element.

◆ dot()

PromotionTraits< field_type, typenameOtherB::field_type >::PromotedType Dune::block_vector_unmanaged< B, std::allocator >::dot ( const block_vector_unmanaged< OtherB, OtherA > & y ) const

inlineinherited

vector dot product \(\left (x^H \cdot y \right)\) which corresponds to Petsc's VecDot

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecDot.html

Parameters

y	other (compatible) vector

Returns

◆ operator*()

PromotionTraits< field_type, typenameOtherB::field_type >::PromotedType Dune::block_vector_unmanaged< B, std::allocator >::operator* ( const block_vector_unmanaged< OtherB, OtherA > & y ) const

inlineinherited

indefinite vector dot product \(\left (x^T \cdot y \right)\) which corresponds to Petsc's VecTDot

http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Vec/VecTDot.html

Parameters

y	other (compatible) vector

Returns

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

dune/istl/vbvector.hh

DUNE Distributed and Unified Numerics Environment

Dune Core Modules (2.3.1)

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ block_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ VariableBlockVector() [1/3]

◆ VariableBlockVector() [2/3]

◆ VariableBlockVector() [3/3]

Member Function Documentation

◆ beforeBegin() [1/2]

◆ beforeBegin() [2/2]

◆ beforeEnd() [1/2]

◆ beforeEnd() [2/2]

◆ dot()

◆ operator*()