Reference documentation for deal.II version 9.2.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Related Functions | List of all members
BlockVector< Number > Class Template Reference
Linear algebra classes » Vector classes

#include <deal.II/lac/block_vector.h>

Inheritance diagram for BlockVector< Number >:
[legend]

Public Types

using BaseClass = BlockVectorBase< Vector< Number > >
 
using BlockType = typename BaseClass::BlockType
 
using value_type = typename BaseClass::value_type
 
using real_type = typename BaseClass::real_type
 
using pointer = typename BaseClass::pointer
 
using const_pointer = typename BaseClass::const_pointer
 
using reference = typename BaseClass::reference
 
using const_reference = typename BaseClass::const_reference
 
using size_type = typename BaseClass::size_type
 
using iterator = typename BaseClass::iterator
 
using const_iterator = typename BaseClass::const_iterator
 
- Public Types inherited from BlockVectorBase< Vector< Number > >
using BlockType = Vector< Number >
 
using value_type = typename BlockType::value_type
 
using pointer = value_type *
 
using const_pointer = const value_type *
 
using iterator = ::internal::BlockVectorIterators::Iterator< BlockVectorBase, false >
 
using const_iterator = ::internal::BlockVectorIterators::Iterator< BlockVectorBase, true >
 
using reference = typename BlockType::reference
 
using const_reference = typename BlockType::const_reference
 
using size_type = types::global_dof_index
 
using real_type = typename BlockType::real_type
 

Public Member Functions

 BlockVector (const unsigned int n_blocks=0, const size_type block_size=0)
 
 BlockVector (const BlockVector< Number > &V)
 
 BlockVector (BlockVector< Number > &&) noexcept=default
 
template<typename OtherNumber >
 BlockVector (const BlockVector< OtherNumber > &v)
 
 BlockVector (const TrilinosWrappers::MPI::BlockVector &v)
 
 BlockVector (const std::vector< size_type > &block_sizes)
 
 BlockVector (const BlockIndices &block_indices)
 
template<typename InputIterator >
 BlockVector (const std::vector< size_type > &block_sizes, const InputIterator first, const InputIterator end)
 
 ~BlockVector () override=default
 
void compress (::VectorOperation::values operation=::VectorOperation::unknown)
 
bool has_ghost_elements () const
 
BlockVector & operator= (const value_type s)
 
BlockVector< Number > & operator= (const BlockVector< Number > &v)
 
BlockVector< Number > & operator= (BlockVector< Number > &&)=default
 
template<class Number2 >
BlockVector< Number > & operator= (const BlockVector< Number2 > &V)
 
BlockVector< Number > & operator= (const Vector< Number > &V)
 
BlockVector< Number > & operator= (const TrilinosWrappers::MPI::BlockVector &V)
 
void reinit (const unsigned int n_blocks, const size_type block_size=0, const bool omit_zeroing_entries=false)
 
void reinit (const std::vector< size_type > &block_sizes, const bool omit_zeroing_entries=false)
 
void reinit (const BlockIndices &block_indices, const bool omit_zeroing_entries=false)
 
template<typename Number2 >
void reinit (const BlockVector< Number2 > &V, const bool omit_zeroing_entries=false)
 
template<class BlockVector2 >
void scale (const BlockVector2 &v)
 
void swap (BlockVector< Number > &v)
 
void print (std::ostream &out, const unsigned int precision=3, const bool scientific=true, const bool across=true) const
 
void block_write (std::ostream &out) const
 
void block_read (std::istream &in)
 
- Public Member Functions inherited from BlockVectorBase< Vector< Number > >
 BlockVectorBase ()=default
 
 BlockVectorBase (const BlockVectorBase &)=default
 
 BlockVectorBase (BlockVectorBase &&) noexcept=default
 
void collect_sizes ()
 
void compress (::VectorOperation::values operation)
 
BlockType & block (const unsigned int i)
 
const BlockType & block (const unsigned int i) const
 
const BlockIndices & get_block_indices () const
 
unsigned int n_blocks () const
 
std::size_t size () const
 
IndexSet locally_owned_elements () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
value_type operator() (const size_type i) const
 
reference operator() (const size_type i)
 
value_type operator[] (const size_type i) const
 
reference operator[] (const size_type i)
 
void extract_subvector_to (const std::vector< size_type > &indices, std::vector< OtherNumber > &values) const
 
void extract_subvector_to (ForwardIterator indices_begin, const ForwardIterator indices_end, OutputIterator values_begin) const
 
BlockVectorBase & operator= (const value_type s)
 
BlockVectorBase & operator= (const BlockVectorBase &V)
 
BlockVectorBase & operator= (BlockVectorBase &&)=default
 
BlockVectorBase & operator= (const BlockVectorBase< VectorType2 > &V)
 
BlockVectorBase & operator= (const Vector< Number > &v)
 
bool operator== (const BlockVectorBase< VectorType2 > &v) const
 
value_type operator* (const BlockVectorBase &V) const
 
real_type norm_sqr () const
 
value_type mean_value () const
 
real_type l1_norm () const
 
real_type l2_norm () const
 
real_type linfty_norm () const
 
value_type add_and_dot (const value_type a, const BlockVectorBase &V, const BlockVectorBase &W)
 
bool in_local_range (const size_type global_index) const
 
bool all_zero () const
 
bool is_non_negative () const
 
BlockVectorBase & operator+= (const BlockVectorBase &V)
 
BlockVectorBase & operator-= (const BlockVectorBase &V)
 
void add (const std::vector< size_type > &indices, const std::vector< Number > &values)
 
void add (const std::vector< size_type > &indices, const Vector< Number > &values)
 
void add (const size_type n_elements, const size_type *indices, const Number *values)
 
void add (const value_type s)
 
void add (const value_type a, const BlockVectorBase &V)
 
void add (const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W)
 
void sadd (const value_type s, const BlockVectorBase &V)
 
void sadd (const value_type s, const value_type a, const BlockVectorBase &V)
 
void sadd (const value_type s, const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W)
 
void sadd (const value_type s, const value_type a, const BlockVectorBase &V, const value_type b, const BlockVectorBase &W, const value_type c, const BlockVectorBase &X)
 
BlockVectorBase & operator*= (const value_type factor)
 
BlockVectorBase & operator/= (const value_type factor)
 
void scale (const BlockVector2 &v)
 
void equ (const value_type a, const BlockVector2 &V)
 
void update_ghost_values () const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptor & operator= (const Subscriptor &)
 
Subscriptor & operator= (Subscriptor &&) noexcept
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Static Public Member Functions

static ::ExceptionBase & ExcIteratorRangeDoesNotMatchVectorSize ()
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBase & ExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBase & ExcNoSubscriber (std::string arg1, std::string arg2)
 

Related Functions

(Note that these are not member functions.)

template<typename Number >
void swap (BlockVector< Number > &u, BlockVector< Number > &v)
 
template<typename Number >
void swap (LinearAlgebra::distributed::BlockVector< Number > &u, LinearAlgebra::distributed::BlockVector< Number > &v)
 

Additional Inherited Members

- Protected Attributes inherited from BlockVectorBase< Vector< Number > >
std::vector< Vector< Number > > components
 
BlockIndices block_indices
 

Detailed Description

template<typename Number>
class BlockVector< Number >

An implementation of block vectors based on deal.II vectors. While the base class provides for most of the interface, this class handles the actual allocation of vectors and provides functions that are specific to the underlying vector type.

Note
Instantiations for this template are provided for <float> and <double>; others can be generated in application programs (see the section on Template instantiations in the manual).
See also
Block (linear algebra)
Author
Wolfgang Bangerth, Guido Kanschat, 1999, 2000, 2001, 2002, 2004

Definition at line 71 of file block_vector.h.

Friends And Related Function Documentation

◆ swap()

template<typename Number >
void swap ( LinearAlgebra::distributed::BlockVector< Number > &  u,
LinearAlgebra::distributed::BlockVector< Number > &  v 
)
related

Global function which overloads the default implementation of the C++ standard library which uses a temporary object. The function simply exchanges the data of the two vectors.

Author
Katharina Kormann, Martin Kronbichler, 2011

Definition at line 716 of file la_parallel_block_vector.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.17