A class to handle Block diagonal preconditioners in a matrix-free implementation. More...

#include <blockoperator.hpp>

Inheritance diagram for mfem::BlockDiagonalPreconditioner:

Collaboration diagram for mfem::BlockDiagonalPreconditioner:

Public Member Functions
	BlockDiagonalPreconditioner (const Array< int > &offsets)
	Constructor that specifies the block structure. More...

void	SetDiagonalBlock (int iblock, Operator *op)
	Add a square block op in the block-entry (iblock, iblock). More...

virtual void	SetOperator (const Operator &op)
	This method is present since required by the abstract base class Solver. More...

int	NumBlocks () const
	Return the number of blocks. More...

Operator &	GetDiagonalBlock (int iblock)
	Return a reference to block i,i. More...

Array< int > &	Offsets ()
	Return the offsets for block starts. More...

virtual void	Mult (const Vector &x, Vector &y) const
	Operator application. More...

virtual void	MultTranspose (const Vector &x, Vector &y) const
	Action of the transpose operator. More...

	~BlockDiagonalPreconditioner ()

Public Member Functions inherited from mfem::Solver
	Solver (int s=0, bool iter_mode=false)

	Solver (int h, int w, bool iter_mode=false)
	Initialize a Solver with height 'h' and width 'w'. More...

Public Member Functions inherited from mfem::Operator
	Operator (int s=0)
	Construct a square Operator with given size s (default 0) More...

	Operator (int h, int w)

int	Height () const
	Get the height (size of output) of the Operator. Synonym with NumRows. More...

int	NumRows () const

int	Width () const
	Get the width (size of input) of the Operator. Synonym with NumCols. More...

int	NumCols () const

virtual Operator &	GetGradient (const Vector &x) const
	Evaluate the gradient operator at the point x. More...

void	PrintMatlab (std::ostream &out, int n=0, int m=0)
	Prints operator with input size n and output size m in matlab format. More...

virtual	~Operator ()

Public Attributes
int	owns_blocks

Public Attributes inherited from mfem::Solver
bool	iterative_mode
	If true, use the second argument of Mult as an initial guess. More...

Additional Inherited Members
Protected Attributes inherited from mfem::Operator
int	height

int	width

Detailed Description

A class to handle Block diagonal preconditioners in a matrix-free implementation.

Usage:

Use the constructors to define the block structure
Use SetDiagonalBlock to fill the BlockOperator
Use the method Mult and MultTranspose to apply the operator to a vector.

If a block is not set, it is assumed it is an identity block

Definition at line 125 of file blockoperator.hpp.

Constructor & Destructor Documentation

mfem::BlockDiagonalPreconditioner::BlockDiagonalPreconditioner ( const Array< int > & offsets )

Constructor that specifies the block structure.

Definition at line 125 of file blockoperator.cpp.

mfem::BlockDiagonalPreconditioner::~BlockDiagonalPreconditioner ( )

Definition at line 188 of file blockoperator.cpp.

Member Function Documentation

Operator& mfem::BlockDiagonalPreconditioner::GetDiagonalBlock ( int iblock )

inline

Return a reference to block i,i.

Definition at line 143 of file blockoperator.hpp.

void mfem::BlockDiagonalPreconditioner::Mult	(	const Vector &	x,
		Vector &	y
	)		const

virtual

Operator application.

Implements mfem::Operator.

Definition at line 148 of file blockoperator.cpp.

void mfem::BlockDiagonalPreconditioner::MultTranspose	(	const Vector &	x,
		Vector &	y
	)		const

virtual

Action of the transpose operator.

Reimplemented from mfem::Operator.

Definition at line 168 of file blockoperator.cpp.

int mfem::BlockDiagonalPreconditioner::NumBlocks ( ) const

inline

Return the number of blocks.

Definition at line 140 of file blockoperator.hpp.

Array<int>& mfem::BlockDiagonalPreconditioner::Offsets ( )

inline

Return the offsets for block starts.

Definition at line 147 of file blockoperator.hpp.

void mfem::BlockDiagonalPreconditioner::SetDiagonalBlock	(	int	iblock,
		Operator *	op
	)

Add a square block op in the block-entry (iblock, iblock).

iblock: The block will be inserted in location (iblock, iblock). op: the Operator to be inserted.

Definition at line 138 of file blockoperator.cpp.

virtual void mfem::BlockDiagonalPreconditioner::SetOperator ( const Operator & op )

inlinevirtual

This method is present since required by the abstract base class Solver.

Implements mfem::Solver.

Definition at line 137 of file blockoperator.hpp.

Member Data Documentation

int mfem::BlockDiagonalPreconditioner::owns_blocks

Controls the ownership of the blocks: if nonzero, BlockDiagonalPreconditioner will delete all blocks that are set (non-NULL); the default value is zero.

Definition at line 160 of file blockoperator.hpp.

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation