dune-istl  2.4.1-rc2
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
Dune::VariableBlockVector< B, A > Class Template Reference

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

#include <dune/istl/vbvector.hh>

Inheritance diagram for Dune::VariableBlockVector< B, A >:
Inheritance graph

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 More...
 
typedef A allocator_type
 export the allocator type More...
 
typedef A::size_type size_type
 The size type for the index access. More...
 
typedef BlockVector< B, A > block_type
 
typedef BlockVectorWindow< B, A > window_type
 
typedef base_array_unmanaged< B, A >::iterator Iterator
 make iterators available as types More...
 
typedef base_array_unmanaged< B, A >::const_iterator ConstIterator
 make iterators available as types More...
 
typedef B value_type
 for STL compatibility More...
 
typedef B member_type
 export the type representing the components More...
 
typedef RealIterator< B > iterator
 iterator type for sequential access More...
 
typedef RealIterator< const B > const_iterator
 iterator class for sequential access More...
 

Public Member Functions

 VariableBlockVector ()
 
 VariableBlockVector (size_type _nblocks)
 
 VariableBlockVector (size_type _nblocks, size_type m)
 
 VariableBlockVector (const VariableBlockVector &a)
 copy constructor, has copy semantics More...
 
 ~VariableBlockVector ()
 free dynamic memory More...
 
void resize (size_type _nblocks)
 same effect as constructor with same argument More...
 
void resize (size_type _nblocks, size_type m)
 same effect as constructor with same argument More...
 
VariableBlockVectoroperator= (const VariableBlockVector &a)
 assignment More...
 
VariableBlockVectoroperator= (const field_type &k)
 assign from scalar More...
 
CreateIterator createbegin ()
 get initial create iterator More...
 
CreateIterator createend ()
 get create iterator pointing to one after the last block More...
 
window_typeoperator[] (size_type i)
 random access to blocks More...
 
const window_typeoperator[] (size_type i) const
 same for read only access More...
 
Iterator begin ()
 begin Iterator More...
 
Iterator end ()
 end Iterator More...
 
Iterator beforeEnd ()
 
Iterator beforeBegin () const
 
Iterator find (size_type i)
 random access returning iterator (end if not contained) More...
 
ConstIterator find (size_type i) const
 random access returning iterator (end if not contained) More...
 
ConstIterator begin () const
 begin ConstIterator More...
 
ConstIterator end () const
 end ConstIterator More...
 
ConstIterator beforeEnd () const
 
ConstIterator rend () const
 end ConstIterator More...
 
size_type N () const
 number of blocks in the vector (are of variable size here) More...
 
block_vector_unmanagedoperator+= (const block_vector_unmanaged &y)
 vector space addition More...
 
block_vector_unmanagedoperator-= (const block_vector_unmanaged &y)
 vector space subtraction More...
 
block_vector_unmanagedoperator*= (const field_type &k)
 vector space multiplication with scalar More...
 
block_vector_unmanagedoperator/= (const field_type &k)
 vector space division by scalar More...
 
block_vector_unmanagedaxpy (const field_type &a, const block_vector_unmanaged &y)
 vector space axpy operation More...
 
template<class OtherB , class OtherA >
PromotionTraits< field_type, typename OtherB::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...
 
template<class OtherB , class OtherA >
PromotionTraits< field_type, typename OtherB::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) More...
 
FieldTraits< field_type >::real_type one_norm_real () const
 simplified one norm (uses Manhattan norm for complex values) More...
 
FieldTraits< field_type >::real_type two_norm () const
 two norm sqrt(sum over squared values of entries) More...
 
FieldTraits< field_type >::real_type two_norm2 () const
 Square of the two-norm (the sum over the squared values of the entries) More...
 
FieldTraits< field_type >::real_type infinity_norm () const
 infinity norm (maximum of absolute values of entries) More...
 
FieldTraits< field_type >::real_type infinity_norm_real () const
 simplified infinity norm (uses Manhattan norm for complex values) More...
 
size_type dim () const
 dimension of the vector space More...
 
iterator beforeBegin ()
 
size_type size () const
 number of blocks in the array (are of size 1 here) More...
 

Protected Attributes

size_type n
 
B * p
 

Detailed Description

template<class B, class A = std::allocator<B>>
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

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

export the allocator type

template<class B, class A = std::allocator<B>>
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).

template<class B, class A = std::allocator<B>>
typedef RealIterator<const B> Dune::base_array_unmanaged< B, A >::const_iterator
inherited

iterator class for sequential access

template<class B, class A = std::allocator<B>>
typedef base_array_unmanaged<B,A>::const_iterator Dune::block_vector_unmanaged< B, A >::ConstIterator
inherited

make iterators available as types

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

export the type representing the field

template<class B, class A = std::allocator<B>>
typedef base_array_unmanaged<B,A>::iterator Dune::block_vector_unmanaged< B, A >::Iterator
inherited

make iterators available as types

template<class B, class A = std::allocator<B>>
typedef RealIterator<B> Dune::base_array_unmanaged< B, A >::iterator
inherited

iterator type for sequential access

template<class B, class A = std::allocator<B>>
typedef B Dune::base_array_unmanaged< B, A >::member_type
inherited

export the type representing the components

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

The size type for the index access.

template<class B, class A = std::allocator<B>>
typedef B Dune::block_vector_unmanaged< B, A >::value_type
inherited

for STL compatibility

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

Member Enumeration Documentation

template<class B, class A = std::allocator<B>>
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

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

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

template<class B, class A = std::allocator<B>>
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

template<class B, class A = std::allocator<B>>
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
_nblocksNumber of blocks
mNumber of elements in each block
template<class B, class A = std::allocator<B>>
Dune::VariableBlockVector< B, A >::VariableBlockVector ( const VariableBlockVector< B, A > &  a)
inline

copy constructor, has copy semantics

template<class B, class A = std::allocator<B>>
Dune::VariableBlockVector< B, A >::~VariableBlockVector ( )
inline

free dynamic memory

Member Function Documentation

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::axpy ( const field_type a,
const block_vector_unmanaged< B, A > &  y 
)
inlineinherited

vector space axpy operation

Referenced by Dune::block_vector_unmanaged< T, A >::axpy().

template<class B, class A = std::allocator<B>>
iterator Dune::base_array_unmanaged< B, A >::beforeBegin ( )
inlineinherited
Returns
an iterator that is positioned before the first entry of the vector.
template<class B, class A = std::allocator<B>>
Iterator Dune::VariableBlockVector< B, A >::beforeBegin ( ) const
inline
Returns
an iterator that is positioned before the first entry of the vector.

Referenced by Dune::Matrix< T, A >::beforeBegin().

template<class B, class A = std::allocator<B>>
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.

Referenced by Dune::Matrix< T, A >::beforeEnd().

template<class B, class A = std::allocator<B>>
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.
template<class B, class A = std::allocator<B>>
Iterator Dune::VariableBlockVector< B, A >::begin ( )
inline
template<class B, class A = std::allocator<B>>
ConstIterator Dune::VariableBlockVector< B, A >::begin ( ) const
inline
template<class B, class A = std::allocator<B>>
CreateIterator Dune::VariableBlockVector< B, A >::createbegin ( )
inline

get initial create iterator

Referenced by test_IO().

template<class B, class A = std::allocator<B>>
CreateIterator Dune::VariableBlockVector< B, A >::createend ( )
inline

get create iterator pointing to one after the last block

Referenced by test_IO().

template<class B, class A = std::allocator<B>>
size_type Dune::block_vector_unmanaged< B, A >::dim ( ) const
inlineinherited
template<class B, class A = std::allocator<B>>
template<class OtherB , class OtherA >
PromotionTraits<field_type,typename OtherB::field_type>::PromotedType Dune::block_vector_unmanaged< B, A >::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
yother (compatible) vector
Returns

Referenced by Dune::block_vector_unmanaged< T, A >::dot().

template<class B, class A = std::allocator<B>>
Iterator Dune::VariableBlockVector< B, A >::end ( )
inline
template<class B, class A = std::allocator<B>>
ConstIterator Dune::VariableBlockVector< B, A >::end ( ) const
inline
template<class B, class A = std::allocator<B>>
Iterator Dune::VariableBlockVector< B, A >::find ( size_type  i)
inline

random access returning iterator (end if not contained)

template<class B, class A = std::allocator<B>>
ConstIterator Dune::VariableBlockVector< B, A >::find ( size_type  i) const
inline

random access returning iterator (end if not contained)

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm ( ) const
inlineinherited
template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::infinity_norm_real ( ) const
inlineinherited

simplified infinity norm (uses Manhattan norm for complex values)

Referenced by Dune::block_vector_unmanaged< T, A >::infinity_norm_real(), and Dune::compressed_block_vector_unmanaged< B, A >::infinity_norm_real().

template<class B, class A = std::allocator<B>>
size_type Dune::VariableBlockVector< B, A >::N ( ) const
inline
template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::one_norm ( ) const
inlineinherited

one norm (sum over absolute values of entries)

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::one_norm_real ( ) const
inlineinherited

simplified one norm (uses Manhattan norm for complex values)

template<class B, class A = std::allocator<B>>
template<class OtherB , class OtherA >
PromotionTraits<field_type,typename OtherB::field_type>::PromotedType Dune::block_vector_unmanaged< B, A >::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
yother (compatible) vector
Returns
template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator*= ( const field_type k)
inlineinherited

vector space multiplication with scalar

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator+= ( const block_vector_unmanaged< B, A > &  y)
inlineinherited

vector space addition

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator-= ( const block_vector_unmanaged< B, A > &  y)
inlineinherited

vector space subtraction

template<class B, class A = std::allocator<B>>
block_vector_unmanaged& Dune::block_vector_unmanaged< B, A >::operator/= ( const field_type k)
inlineinherited

vector space division by scalar

template<class B, class A = std::allocator<B>>
VariableBlockVector& Dune::VariableBlockVector< B, A >::operator= ( const VariableBlockVector< B, A > &  a)
inline

assignment

template<class B, class A = std::allocator<B>>
VariableBlockVector& Dune::VariableBlockVector< B, A >::operator= ( const field_type k)
inline

assign from scalar

template<class B, class A = std::allocator<B>>
window_type& Dune::VariableBlockVector< B, A >::operator[] ( size_type  i)
inline

random access to blocks

template<class B, class A = std::allocator<B>>
const window_type& Dune::VariableBlockVector< B, A >::operator[] ( size_type  i) const
inline

same for read only access

template<class B, class A = std::allocator<B>>
ConstIterator Dune::VariableBlockVector< B, A >::rend ( ) const
inline
template<class B, class A = std::allocator<B>>
void Dune::VariableBlockVector< B, A >::resize ( size_type  _nblocks)
inline

same effect as constructor with same argument

Referenced by Dune::Matrix< T, A >::setSize().

template<class B, class A = std::allocator<B>>
void Dune::VariableBlockVector< B, A >::resize ( size_type  _nblocks,
size_type  m 
)
inline

same effect as constructor with same argument

template<class B, class A = std::allocator<B>>
size_type Dune::base_array_unmanaged< B, A >::size ( ) const
inlineinherited

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

Referenced by Dune::Matrix< T, A >::coldim(), and Dune::BlockVector< FieldVector< T, n >, A >::resize().

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::two_norm ( ) const
inlineinherited

two norm sqrt(sum over squared values of entries)

Referenced by test_Iter().

template<class B, class A = std::allocator<B>>
FieldTraits<field_type>::real_type Dune::block_vector_unmanaged< B, A >::two_norm2 ( ) const
inlineinherited

Square of the two-norm (the sum over the squared values of the entries)

Member Data Documentation

template<class B, class A = std::allocator<B>>
size_type Dune::base_array_unmanaged< B, A >::n
protectedinherited

Referenced by Dune::base_array_window< B, A >::advance(), Dune::block_vector_unmanaged< T, A >::axpy(), Dune::base_array< B, A >::base_array(), Dune::base_array_unmanaged< T, A >::beforeEnd(), Dune::compressed_base_array_unmanaged< B, A >::beforeEnd(), Dune::BlockVector< FieldVector< T, n >, A >::BlockVector(), Dune::BlockVectorWindow< B, A >::BlockVectorWindow(), Dune::CompressedBlockVectorWindow< B, A >::CompressedBlockVectorWindow(), Dune::block_vector_unmanaged< T, A >::dim(), Dune::compressed_block_vector_unmanaged< B, A >::dim(), Dune::block_vector_unmanaged< T, A >::dot(), Dune::base_array_unmanaged< T, A >::end(), Dune::compressed_base_array_unmanaged< B, A >::end(), Dune::base_array_unmanaged< T, A >::find(), Dune::compressed_base_array_unmanaged< B, A >::find(), Dune::BlockVectorWindow< B, A >::getsize(), Dune::CompressedBlockVectorWindow< B, A >::getsize(), Dune::block_vector_unmanaged< T, A >::infinity_norm(), Dune::compressed_block_vector_unmanaged< B, A >::infinity_norm(), Dune::block_vector_unmanaged< T, A >::infinity_norm_real(), Dune::compressed_block_vector_unmanaged< B, A >::infinity_norm_real(), Dune::base_array_window< B, A >::move(), Dune::block_vector_unmanaged< T, A >::N(), Dune::compressed_block_vector_unmanaged< B, A >::N(), Dune::block_vector_unmanaged< T, A >::one_norm(), Dune::compressed_block_vector_unmanaged< B, A >::one_norm(), Dune::block_vector_unmanaged< T, A >::one_norm_real(), Dune::compressed_block_vector_unmanaged< B, A >::one_norm_real(), Dune::block_vector_unmanaged< T, A >::operator*(), Dune::compressed_block_vector_unmanaged< B, A >::operator*(), Dune::block_vector_unmanaged< T, A >::operator*=(), Dune::compressed_block_vector_unmanaged< B, A >::operator*=(), Dune::VariableBlockVector< B, A >::CreateIterator::operator++(), Dune::block_vector_unmanaged< T, A >::operator+=(), Dune::block_vector_unmanaged< T, A >::operator-=(), Dune::block_vector_unmanaged< T, A >::operator/=(), Dune::compressed_block_vector_unmanaged< B, A >::operator/=(), Dune::block_vector_unmanaged< T, A >::operator=(), Dune::VariableBlockVector< T, A >::operator=(), Dune::base_array< B, A >::operator=(), Dune::BlockVector< FieldVector< T, n >, A >::operator=(), Dune::BlockVectorWindow< B, A >::operator=(), Dune::compressed_block_vector_unmanaged< B, A >::operator=(), Dune::CompressedBlockVectorWindow< B, A >::operator=(), Dune::base_array_unmanaged< T, A >::operator[](), Dune::compressed_base_array_unmanaged< B, A >::operator[](), Dune::VariableBlockVector< T, A >::resize(), Dune::BlockVector< FieldVector< T, n >, A >::resize(), Dune::base_array< B, A >::resize(), Dune::base_array_window< B, A >::set(), Dune::BlockVectorWindow< B, A >::set(), Dune::CompressedBlockVectorWindow< B, A >::set(), Dune::BlockVectorWindow< B, A >::setsize(), Dune::CompressedBlockVectorWindow< B, A >::setsize(), Dune::base_array_unmanaged< T, A >::size(), Dune::compressed_base_array_unmanaged< B, A >::size(), Dune::block_vector_unmanaged< T, A >::two_norm(), Dune::compressed_block_vector_unmanaged< B, A >::two_norm(), Dune::block_vector_unmanaged< T, A >::two_norm2(), Dune::compressed_block_vector_unmanaged< B, A >::two_norm2(), Dune::VariableBlockVector< T, A >::VariableBlockVector(), Dune::base_array< B, A >::~base_array(), and Dune::VariableBlockVector< T, A >::~VariableBlockVector().

template<class B, class A = std::allocator<B>>
B* Dune::base_array_unmanaged< B, A >::p
protectedinherited

Referenced by Dune::base_array< B, A >::base_array(), Dune::BlockVector< FieldVector< T, n >, A >::BlockVector(), Dune::BlockVectorWindow< B, A >::BlockVectorWindow(), Dune::CompressedBlockVectorWindow< B, A >::CompressedBlockVectorWindow(), Dune::VariableBlockVector< B, A >::ConstIterator::ConstIterator(), Dune::compressed_block_vector_unmanaged< B, A >::dim(), Dune::BlockVectorWindow< B, A >::getptr(), Dune::CompressedBlockVectorWindow< B, A >::getptr(), Dune::compressed_block_vector_unmanaged< B, A >::infinity_norm(), Dune::compressed_block_vector_unmanaged< B, A >::infinity_norm_real(), Dune::VariableBlockVector< B, A >::Iterator::Iterator(), Dune::compressed_block_vector_unmanaged< B, A >::one_norm(), Dune::compressed_block_vector_unmanaged< B, A >::one_norm_real(), Dune::VariableBlockVector< B, A >::Iterator::operator!=(), Dune::VariableBlockVector< B, A >::ConstIterator::operator!=(), Dune::VariableBlockVector< B, A >::Iterator::operator*(), Dune::VariableBlockVector< B, A >::ConstIterator::operator*(), Dune::compressed_block_vector_unmanaged< B, A >::operator*(), Dune::compressed_block_vector_unmanaged< B, A >::operator*=(), Dune::VariableBlockVector< B, A >::CreateIterator::operator++(), Dune::VariableBlockVector< B, A >::Iterator::operator->(), Dune::VariableBlockVector< B, A >::ConstIterator::operator->(), Dune::compressed_block_vector_unmanaged< B, A >::operator/=(), Dune::VariableBlockVector< T, A >::operator=(), Dune::base_array< B, A >::operator=(), Dune::BlockVector< FieldVector< T, n >, A >::operator=(), Dune::BlockVectorWindow< B, A >::operator=(), Dune::compressed_block_vector_unmanaged< B, A >::operator=(), Dune::CompressedBlockVectorWindow< B, A >::operator=(), Dune::VariableBlockVector< B, A >::Iterator::operator==(), Dune::VariableBlockVector< B, A >::ConstIterator::operator==(), Dune::base_array_unmanaged< T, A >::operator[](), Dune::BlockVector< FieldVector< T, n >, A >::reserve(), Dune::VariableBlockVector< T, A >::resize(), Dune::BlockVectorWindow< B, A >::set(), Dune::CompressedBlockVectorWindow< B, A >::set(), Dune::BlockVectorWindow< B, A >::setptr(), Dune::CompressedBlockVectorWindow< B, A >::setptr(), Dune::compressed_block_vector_unmanaged< B, A >::two_norm(), Dune::compressed_block_vector_unmanaged< B, A >::two_norm2(), Dune::VariableBlockVector< T, A >::VariableBlockVector(), Dune::BlockVector< FieldVector< T, n >, A >::~BlockVector(), and Dune::VariableBlockVector< T, A >::~VariableBlockVector().


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