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

Inheritance diagram for BlockLinearOperator< Range, Domain >:

Public Member Functions
	BlockLinearOperator ()

	BlockLinearOperator (const BlockLinearOperator< Range, Domain > &)=default

template<typename Op >
	BlockLinearOperator (const Op &op)

template<size_t m, size_t n>
	BlockLinearOperator (const std::array< std::array< BlockType, n >, m > &ops)

template<size_t m>
	BlockLinearOperator (const std::array< BlockType, m > &ops)

BlockLinearOperator< Range, Domain > &	operator= (const BlockLinearOperator< Range, Domain > &)=default

template<typename Op >
BlockLinearOperator< Range, Domain > &	operator= (const Op &op)

template<size_t m, size_t n>
BlockLinearOperator< Range, Domain > &	operator= (const std::array< std::array< BlockType, n >, m > &ops)

template<size_t m>
BlockLinearOperator< Range, Domain > &	operator= (const std::array< BlockType, m > &ops)

Public Member Functions inherited from LinearOperator< Range, Domain >
	LinearOperator ()

	LinearOperator (const LinearOperator< Range, Domain > &)=default

template<typename Op , typename = typename std::enable_if<!std::is_base_of<LinearOperator<Range, Domain>, Op>::value>::type>
	LinearOperator (const Op &op)

LinearOperator< Range, Domain > &	operator= (const LinearOperator< Range, Domain > &)=default

template<typename Op , typename = typename std::enable_if<!std::is_base_of<LinearOperator<Range, Domain>, Op>::value>::type>
LinearOperator< Range, Domain > &	operator= (const Op &op)

LinearOperator< Range, Domain > &	operator+= (const LinearOperator< Range, Domain > &second_op)

LinearOperator< Range, Domain > &	operator-= (const LinearOperator< Range, Domain > &second_op)

LinearOperator< Range, Domain > &	operator*= (const LinearOperator< Domain, Domain > &second_op)

LinearOperator< Range, Domain >	operator*= (typename Domain::value_type number)

Public Attributes
std::function< unsigned int()>	n_block_rows

std::function< unsigned int()>	n_block_cols

std::function< BlockType(unsigned int, unsigned int)>	block

Public Attributes inherited from LinearOperator< Range, Domain >
std::function< void(Range &v, const Domain &u)>	vmult

std::function< void(Range &v, const Domain &u)>	vmult_add

std::function< void(Domain &v, const Range &u)>	Tvmult

std::function< void(Domain &v, const Range &u)>	Tvmult_add

std::function< void(Range &v, bool omit_zeroing_entries)>	reinit_range_vector

std::function< void(Domain &v, bool omit_zeroing_entries)>	reinit_domain_vector

bool	is_null_operator

Related Functions
(Note that these are not member functions.)
Creation of a BlockLinearOperator
template<typename Range , typename Domain , typename BlockMatrixType >
BlockLinearOperator< Range, Domain >	block_operator (const BlockMatrixType &block_matrix)

template<size_t m, size_t n, typename Range , typename Domain >
BlockLinearOperator< Range, Domain >	block_operator (const std::array< std::array< LinearOperator< typename Range::BlockType, typename Domain::BlockType >, n >, m > &ops)

template<typename Range , typename Domain , typename BlockMatrixType >
BlockLinearOperator< Range, Domain >	block_diagonal_operator (const BlockMatrixType &block_matrix)

template<size_t m, typename Range , typename Domain >
BlockLinearOperator< Range, Domain >	block_diagonal_operator (const std::array< LinearOperator< typename Range::BlockType, typename Domain::BlockType >, m > &ops)

template<size_t m, typename Range , typename Domain >
BlockLinearOperator< Range, Domain >	block_diagonal_operator (const LinearOperator< typename Range::BlockType, typename Domain::BlockType > &op)

Manipulation of a BlockLinearOperator
template<typename Range , typename Domain >
LinearOperator< Domain, Range >	block_forward_substitution (const BlockLinearOperator< Range, Domain > &block_operator, const BlockLinearOperator< Domain, Range > &diagonal_inverse)

template<typename Range , typename Domain >
LinearOperator< Domain, Range >	block_back_substitution (const BlockLinearOperator< Range, Domain > &block_operator, const BlockLinearOperator< Domain, Range > &diagonal_inverse)

Related Functions inherited from LinearOperator< Range, Domain >
template<typename Range , typename Domain >
LinearOperator< Range, Domain >	distribute_constraints_linear_operator (const ConstraintMatrix &constraint_matrix, const LinearOperator< Range, Domain > &exemplar)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	project_to_constrained_linear_operator (const ConstraintMatrix &constraint_matrix, const LinearOperator< Range, Domain > &exemplar)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	constrained_linear_operator (const ConstraintMatrix &constraint_matrix, const LinearOperator< Range, Domain > &linop)

template<typename Range , typename Domain >
PackagedOperation< Range >	constrained_right_hand_side (const ConstraintMatrix &constraint_matrix, const LinearOperator< Range, Domain > &linop, const Range &right_hand_side)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	operator+ (const LinearOperator< Range, Domain > &first_op, const LinearOperator< Range, Domain > &second_op)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	operator- (const LinearOperator< Range, Domain > &first_op, const LinearOperator< Range, Domain > &second_op)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	operator* (typename Range::value_type number, const LinearOperator< Range, Domain > &op)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	operator* (const LinearOperator< Range, Domain > &op, typename Domain::value_type number)

template<typename Range , typename Intermediate , typename Domain >
LinearOperator< Range, Domain >	operator* (const LinearOperator< Range, Intermediate > &first_op, const LinearOperator< Intermediate, Domain > &second_op)

template<typename Range , typename Domain >
LinearOperator< Domain, Range >	transpose_operator (const LinearOperator< Range, Domain > &op)

template<typename Solver , typename Preconditioner >
LinearOperator< typename Solver::vector_type, typename Solver::vector_type >	inverse_operator (const LinearOperator< typename Solver::vector_type, typename Solver::vector_type > &op, Solver &solver, const Preconditioner &preconditioner)

template<typename Range >
LinearOperator< Range, Range >	identity_operator (const std::function< void(Range &, bool)> &reinit_vector)

template<typename Range , typename Domain >
LinearOperator< Range, Domain >	null_operator (const LinearOperator< Range, Domain > &op)

template<typename Range , typename Domain , typename Matrix >
LinearOperator< Range, Domain >	linear_operator (const Matrix &matrix)

template<typename Range , typename Domain , typename OperatorExemplar , typename Matrix >
LinearOperator< Range, Domain >	linear_operator (const OperatorExemplar &operator_exemplar, const Matrix &matrix)

template<typename Range_1 , typename Domain_1 , typename Range_2 , typename Domain_2 >
LinearOperator< Range_2, Domain_2 >	schur_complement (const LinearOperator< Domain_1, Range_1 > &A_inv, const LinearOperator< Range_1, Domain_2 > &B, const LinearOperator< Range_2, Domain_1 > &C, const LinearOperator< Range_2, Domain_2 > &D)

Detailed Description

template<typename Range, typename Domain>
class BlockLinearOperator< Range, Domain >

A class to store the concept of a block linear operator.

This class increases the interface of LinearOperator (which encapsulates the Matrix interface) by three additional functions:

std::function<unsigned int()> n_block_rows;
std::function<unsigned int()> n_block_cols;
std::function<BlockType(unsigned int, unsigned int)> block;

that describe the underlying block structure (of an otherwise opaque) linear operator.

Objects of type BlockLinearOperator can be created similarly to LinearOperator with a wrapper function:

::BlockSparseMatrix<double> A;

const auto block_op_a = block_operator(A);

A BlockLinearOperator can be sliced to a LinearOperator at any time. This removes all information about the underlying block structure (beacuse above std::function objects are no longer available) - the linear operator interface, however, remains intact.

Note: This class makes heavy use of std::function objects and lambda functions. This flexibiliy comes with a run-time penalty. Only use this object to encapsulate object with medium to large individual block sizes, and small block structure (as a rule of thumb, matrix blocks greater than $1000\times1000$ ).; This class is only available if deal.II was configured with C++11 support, i.e., if DEAL_II_WITH_CXX11 is enabled during cmake configure.

Author: Matthias Maier, 2015

Definition at line 34 of file block_linear_operator.h.

Constructor & Destructor Documentation

§ BlockLinearOperator() [1/5]

template<typename Range, typename Domain>

BlockLinearOperator< Range, Domain >::BlockLinearOperator ( )

inline

Create an empty BlockLinearOperator object.

Allstd::function member objects of this class and its base class LinearOperator are initialized with default variants that throw an exception upon invocation.

Definition at line 142 of file block_linear_operator.h.

§ BlockLinearOperator() [2/5]

template<typename Range, typename Domain>

BlockLinearOperator< Range, Domain >::BlockLinearOperator ( const BlockLinearOperator< Range, Domain > & )

default

Default copy constructor.

§ BlockLinearOperator() [3/5]

template<typename Range, typename Domain>

template<typename Op >

BlockLinearOperator< Range, Domain >::BlockLinearOperator ( const Op & op )

inline

Templated copy constructor that creates a BlockLinearOperator object from an object op for which the conversion function block_operator is defined.

Definition at line 177 of file block_linear_operator.h.

§ BlockLinearOperator() [4/5]

template<typename Range, typename Domain>

template<size_t m, size_t n>

BlockLinearOperator< Range, Domain >::BlockLinearOperator ( const std::array< std::array< BlockType, n >, m > & ops )

inline

Create a BlockLinearOperator from a two-dimensional array ops of LinearOperator. This constructor calls the corresponding block_operator() specialization.

Definition at line 188 of file block_linear_operator.h.

§ BlockLinearOperator() [5/5]

template<typename Range, typename Domain>

template<size_t m>

BlockLinearOperator< Range, Domain >::BlockLinearOperator ( const std::array< BlockType, m > & ops )

inline

Create a block-diagonal BlockLinearOperator from a one-dimensional array ops of LinearOperator. This constructor calls the corresponding block_operator() specialization.

Definition at line 199 of file block_linear_operator.h.

Member Function Documentation

§ operator=() [1/4]

template<typename Range, typename Domain>

BlockLinearOperator<Range, Domain>& BlockLinearOperator< Range, Domain >::operator= ( const BlockLinearOperator< Range, Domain > & )

default

Default copy assignment operator.

§ operator=() [2/4]

template<typename Range, typename Domain>

template<typename Op >

BlockLinearOperator<Range, Domain>& BlockLinearOperator< Range, Domain >::operator= ( const Op & op )

inline

Templated copy assignment operator for an object op for which the conversion function block_operator is defined.

Definition at line 215 of file block_linear_operator.h.

§ operator=() [3/4]

template<typename Range, typename Domain>

template<size_t m, size_t n>

BlockLinearOperator<Range, Domain>& BlockLinearOperator< Range, Domain >::operator= ( const std::array< std::array< BlockType, n >, m > & ops )

inline

Copy assignment from a two-dimensional array ops of LinearOperator. This assignment operator calls the corresponding block_operator() specialization.

Definition at line 228 of file block_linear_operator.h.

§ operator=() [4/4]

template<typename Range, typename Domain>

template<size_t m>

BlockLinearOperator<Range, Domain>& BlockLinearOperator< Range, Domain >::operator= ( const std::array< BlockType, m > & ops )

inline

Copy assignment from a one-dimensional array ops of LinearOperator that creates a block-diagonal BlockLinearOperator. This assignment operator calls the corresponding block_operator() specialization.

Definition at line 241 of file block_linear_operator.h.

Member Data Documentation

§ n_block_rows

template<typename Range, typename Domain>

std::function<unsigned int()> BlockLinearOperator< Range, Domain >::n_block_rows

Return the number of blocks in a column (i.e, the number of "block rows", or the number $m$ , if interpreted as a $m\times n$ block system).

Definition at line 251 of file block_linear_operator.h.

§ n_block_cols

template<typename Range, typename Domain>

std::function<unsigned int()> BlockLinearOperator< Range, Domain >::n_block_cols

Return the number of blocks in a row (i.e, the number of "block columns", or the number $n$ , if interpreted as a $m\times n$ block system).

Definition at line 257 of file block_linear_operator.h.

§ block

template<typename Range, typename Domain>

std::function<BlockType(unsigned int, unsigned int)> BlockLinearOperator< Range, Domain >::block

Access the block with the given coordinates. This std::function object returns a LinearOperator representing the $(i,j)$ -th block of the BlockLinearOperator.

Definition at line 264 of file block_linear_operator.h.

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

deal.II/lac/block_linear_operator.h

Public Member Functions

Public Attributes

Related Functions

Detailed Description

template<typename Range, typename Domain> class BlockLinearOperator< Range, Domain >

Constructor & Destructor Documentation

§ BlockLinearOperator() [1/5]

§ BlockLinearOperator() [2/5]

§ BlockLinearOperator() [3/5]

§ BlockLinearOperator() [4/5]

§ BlockLinearOperator() [5/5]

Member Function Documentation

§ operator=() [1/4]

§ operator=() [2/4]

§ operator=() [3/4]

§ operator=() [4/4]

Member Data Documentation

§ n_block_rows

§ n_block_cols

§ block

template<typename Range, typename Domain>
class BlockLinearOperator< Range, Domain >