MFEM  v3.3.2
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | List of all members
mfem::BlockDiagonalPreconditioner Class Reference

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

#include <blockoperator.hpp>

Inheritance diagram for mfem::BlockDiagonalPreconditioner:
[legend]
Collaboration diagram for mfem::BlockDiagonalPreconditioner:
[legend]

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...
 
OperatorGetDiagonalBlock (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)
 Initialize a square Solver with size s. More...
 
 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)
 Construct an Operator with the given height (output size) and width (input size). More...
 
int Height () const
 Get the height (size of output) of the Operator. Synonym with NumRows(). More...
 
int NumRows () const
 Get the number of rows (size of output) of the Operator. Synonym with Height(). More...
 
int Width () const
 Get the width (size of input) of the Operator. Synonym with NumCols(). More...
 
int NumCols () const
 Get the number of columns (size of input) of the Operator. Synonym with Width(). More...
 
virtual OperatorGetGradient (const Vector &x) const
 Evaluate the gradient operator at the point x. The default behavior in class Operator is to generate an error. More...
 
virtual const OperatorGetProlongation () const
 Prolongation operator from linear algebra (linear system) vectors, to input vectors for the operator. NULL means identity. More...
 
virtual const OperatorGetRestriction () const
 Restriction operator from input vectors for the operator to linear algebra (linear system) vectors. NULL means identity. More...
 
void FormLinearSystem (const Array< int > &ess_tdof_list, Vector &x, Vector &b, Operator *&A, Vector &X, Vector &B, int copy_interior=0)
 Form a constrained linear system using a matrix-free approach. More...
 
virtual void RecoverFEMSolution (const Vector &X, const Vector &b, Vector &x)
 Reconstruct a solution vector x (e.g. a GridFunction) from the solution X of a constrained linear system obtained from Operator::FormLinearSystem(). More...
 
void PrintMatlab (std::ostream &out, int n=0, int m=0) const
 Prints operator with input size n and output size m in Matlab format. More...
 
virtual ~Operator ()
 Virtual destructor. More...
 

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

- Public Types inherited from mfem::Operator
enum  Type {
  MFEM_SPARSEMAT, Hypre_ParCSR, PETSC_MATAIJ, PETSC_MATIS,
  PETSC_MATSHELL, PETSC_MATNEST, PETSC_MATHYPRE, PETSC_MATGENERIC
}
 Enumeration defining IDs for some classes derived from Operator. More...
 
- Protected Attributes inherited from mfem::Operator
int height
 Dimension of the output / number of rows in the matrix. More...
 
int width
 Dimension of the input / number of columns in the matrix. More...
 

Detailed Description

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

Usage:

If a block is not set, it is assumed to be an identity block.

Definition at line 135 of file blockoperator.hpp.

Constructor & Destructor Documentation

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

Constructor that specifies the block structure.

Definition at line 128 of file blockoperator.cpp.

mfem::BlockDiagonalPreconditioner::~BlockDiagonalPreconditioner ( )

Definition at line 191 of file blockoperator.cpp.

Member Function Documentation

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

Return a reference to block i,i.

Definition at line 153 of file blockoperator.hpp.

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

Operator application.

Implements mfem::Operator.

Definition at line 151 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 171 of file blockoperator.cpp.

int mfem::BlockDiagonalPreconditioner::NumBlocks ( ) const
inline

Return the number of blocks.

Definition at line 150 of file blockoperator.hpp.

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

Return the offsets for block starts.

Definition at line 157 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 141 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 147 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 170 of file blockoperator.hpp.


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