#include <PreconditionerBlock.hpp>

Inheritance diagram for PreconditionerBlock:

Collaboration diagram for PreconditionerBlock:

Constructors, destructor
	PreconditionerBlock (const std::shared_ptr< Epetra_Comm > &comm=std::shared_ptr< Epetra_Comm >())
	default constructor. More...

	PreconditionerBlock (PreconditionerBlock &P, const std::shared_ptr< Epetra_Comm > &comm=std::shared_ptr< Epetra_Comm >())
	Copy constructor. More...

virtual	~PreconditionerBlock ()
	default virtual destructor More...

Methods
virtual int	numBlocksRows () const =0

virtual int	numBlocksCols () const =0

Additional Inherited Members
Public Types inherited from Preconditioner
typedef Epetra_Operator	prec_raw_type

typedef std::shared_ptr< prec_raw_type >	prec_type

typedef MatrixEpetra< Real >	operator_raw_type

typedef std::shared_ptr< operator_raw_type >	operator_type

typedef Displayer::comm_Type	comm_Type

typedef Displayer::commPtr_Type	commPtr_Type

typedef Teuchos::ParameterList	list_Type

Public Member Functions inherited from Preconditioner
	Preconditioner (const commPtr_Type &comm=commPtr_Type())
	Constructor. More...

	Preconditioner (const Preconditioner &preconditioner, const commPtr_Type &comm=commPtr_Type())
	Copy constructor. More...

virtual	~Preconditioner ()
	Destructor. More...

virtual void	createParametersList (list_Type &list, const GetPot &dataFile, const std::string &section, const std::string &subSection)=0
	Create the list of parameters of the preconditioner. More...

virtual Int	buildPreconditioner (operator_type &matrix)=0
	Build a preconditioner based on the given matrix. More...

virtual void	resetPreconditioner ()=0
	Reset the preconditioner. More...

virtual Real	condest ()=0
	Return An estimation of the condition number of the preconditioner. More...

virtual void	showMe (std::ostream &output=std::cout) const
	Show informations about the preconditioner. More...

virtual Int	SetUseTranspose (const bool useTranspose=false)
	Set the matrix to be used transposed (or not) More...

virtual bool	UseTranspose ()
	Return true if the preconditioner is transposed. More...

virtual Int	Apply (const Epetra_MultiVector &vector1, Epetra_MultiVector &vector2) const
	Apply the inverse of the preconditioner on vector1 and store the result in vector2. More...

virtual Int	ApplyInverse (const Epetra_MultiVector &vector1, Epetra_MultiVector &vector2) const
	Apply the inverse of the preconditioner on vector1 and store the result in vector2. More...

virtual const Epetra_Map &	OperatorRangeMap () const
	Return the Range map of the operator. More...

virtual const Epetra_Map &	OperatorDomainMap () const
	Return the Domain map of the operator. More...

void	setParametersList (const list_Type &list)
	The the internal list. More...

virtual void	setDataFromGetPot (const GetPot &dataFile, const std::string &section)=0
	Set the data of the preconditioner using a GetPot object. More...

virtual void	setSolver (SolverAztecOO &)
	Set the internal solver. More...

const bool &	preconditionerCreated ()
	Return true if the preconditioner has been created. More...

virtual prec_raw_type *	preconditioner ()=0
	Return a raw pointer on the preconditioner. More...

virtual prec_type	preconditionerPtr ()=0
	Return a shared pointer on the preconditioner. More...

virtual std::string	preconditionerType ()=0
	Return the type of preconditioner. More...

const list_Type &	parametersList () const
	Return the parameters list. More...

list_Type &	parametersList ()
	Return the parameters list. More...

Protected Attributes inherited from Preconditioner
std::string	M_precType

Displayer	M_displayer

list_Type	M_list

bool	M_preconditionerCreated

Detailed Description

PreconditionerBlock.

Author: Gwenol Grandperrin

The PreconditionerBlock class is an abstract class which defines the interfaces for a typical block preconditioner

Definition at line 55 of file PreconditionerBlock.hpp.

Constructor & Destructor Documentation

◆ PreconditionerBlock() [1/2]

PreconditionerBlock ( const std::shared_ptr< Epetra_Comm > & comm = std::shared_ptr<Epetra_Comm>() )

default constructor.

Definition at line 42 of file PreconditionerBlock.cpp.

Here is the caller graph for this function:

◆ PreconditionerBlock() [2/2]

PreconditionerBlock	(	PreconditionerBlock &	P,
		const std::shared_ptr< Epetra_Comm > &	comm = `std::shared_ptr<Epetra_Comm>()`
	)

Copy constructor.

Definition at line 48 of file PreconditionerBlock.cpp.

Here is the caller graph for this function:

◆ ~PreconditionerBlock()

~PreconditionerBlock ( )

virtual

default virtual destructor

Definition at line 54 of file PreconditionerBlock.cpp.

Member Function Documentation

◆ numBlocksRows()

virtual int numBlocksRows ( ) const

pure virtual

◆ numBlocksCols()

virtual int numBlocksCols ( ) const

pure virtual

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

Constructors, destructor

Methods

Additional Inherited Members