PreconditionerAztecOO - The implementation of Preconditioner for AztecOO preconditioners. More...

#include <PreconditionerAztecOO.hpp>

Inheritance diagram for PreconditionerAztecOO:

Collaboration diagram for PreconditionerAztecOO:

Private Attributes
Solver_Type *	M_solver

Public Types
typedef Preconditioner	super

typedef super::operator_raw_type	operator_raw_type

typedef super::operator_type	operator_type

typedef SolverAztecOO	Solver_Type

Constructors & Destructor
	PreconditionerAztecOO ()
	Constructor. More...

virtual	~PreconditionerAztecOO ()
	Destructor. More...

Methods
Int	buildPreconditioner (operator_type &matrix)
	Build the preconditioner. More...

void	resetPreconditioner ()
	Reset the preconditioner. More...

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

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

Real	condest ()
	Compute the condition number of the preconditioner. More...

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

void	setSolver (SolverAztecOO &solver)
	Set the external solver (AztecOO) More...

Get Methods
super::prec_raw_type *	preconditioner ()
	Return the pointer to the preconditioner. More...

super::prec_type	preconditionerPtr ()
	Return the shared pointer to the preconditioner. More...

std::string	preconditionerType ()
	Return the name of the preconditioner. More...

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 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...

const bool &	preconditionerCreated ()
	Return true if the preconditioner has been created. 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

PreconditionerAztecOO - The implementation of Preconditioner for AztecOO preconditioners.

Author: Cristiano Malossi crist.nosp@m.inao.nosp@m..malo.nosp@m.ssi@.nosp@m.epfl..nosp@m.ch

This class provides the interface for using AztecOO preconditioners with SolverAztecOO.

Definition at line 53 of file PreconditionerAztecOO.hpp.

Member Typedef Documentation

◆ super

typedef Preconditioner super

Definition at line 60 of file PreconditionerAztecOO.hpp.

◆ operator_raw_type

typedef super::operator_raw_type operator_raw_type

Definition at line 62 of file PreconditionerAztecOO.hpp.

◆ operator_type

typedef super::operator_type operator_type

Definition at line 63 of file PreconditionerAztecOO.hpp.

◆ Solver_Type

typedef SolverAztecOO Solver_Type

Definition at line 65 of file PreconditionerAztecOO.hpp.

Constructor & Destructor Documentation

◆ PreconditionerAztecOO()

PreconditionerAztecOO ( )

Constructor.

Definition at line 47 of file PreconditionerAztecOO.cpp.

◆ ~PreconditionerAztecOO()

virtual ~PreconditionerAztecOO ( )

inlinevirtual

Destructor.

Definition at line 77 of file PreconditionerAztecOO.hpp.

Member Function Documentation

◆ buildPreconditioner()

Int buildPreconditioner ( operator_type & matrix )

virtual

Build the preconditioner.

Parameters

A	the base matrix for computing the preconditioner

Implements Preconditioner.

Definition at line 63 of file PreconditionerAztecOO.cpp.

◆ resetPreconditioner()

void resetPreconditioner ( )

virtual

Reset the preconditioner.

Implements Preconditioner.

Definition at line 89 of file PreconditionerAztecOO.cpp.

Here is the caller graph for this function:

◆ createParametersList()

void createParametersList	(	list_Type &	list,
		const GetPot &	dataFile,
		const std::string &	section,
		const std::string &	subSection
	)

virtual

Create the list of parameters of the preconditioner.

Parameters

list	A Parameter list to be filled
dataFile	A GetPot object containing the data about the preconditioner
section	The section in "dataFile" where to find data about the preconditioner
subSection	The subsection in "dataFile" where to find data about the preconditioner

Implements Preconditioner.

Definition at line 109 of file PreconditionerAztecOO.cpp.

◆ showMe()

void showMe ( std::ostream & output = std::cout ) const

virtual

Show informations about the preconditioner.

Reimplemented from Preconditioner.

Definition at line 170 of file PreconditionerAztecOO.cpp.

◆ condest()

Real condest ( )

virtual

Compute the condition number of the preconditioner.

Returns: Condition number of the preconditioner

Implements Preconditioner.

Definition at line 176 of file PreconditionerAztecOO.cpp.

◆ setDataFromGetPot()

void setDataFromGetPot	(	const GetPot &	dataFile,
		const std::string &	section
	)

virtual

Set the data of the preconditioner using a GetPot object.

Parameters

dataFile	A GetPot object containing the data about the preconditioner
section	The section in "dataFile" where to find data about the preconditioner

Implements Preconditioner.

Definition at line 190 of file PreconditionerAztecOO.cpp.

◆ setSolver()

void setSolver ( SolverAztecOO & solver )

inlinevirtual

Set the external solver (AztecOO)

Parameters

solver reference to the AztecOO solver

Reimplemented from Preconditioner.

Definition at line 129 of file PreconditionerAztecOO.hpp.

◆ preconditioner()

Preconditioner::prec_raw_type * preconditioner ( )

virtual

Return the pointer to the preconditioner.

Returns: always zero because no external precondtioner is used here!

Implements Preconditioner.

Definition at line 206 of file PreconditionerAztecOO.cpp.

◆ preconditionerPtr()

Preconditioner::prec_type preconditionerPtr ( )

virtual

Return the shared pointer to the preconditioner.

Implements Preconditioner.

Definition at line 222 of file PreconditionerAztecOO.cpp.

◆ preconditionerType()

std::string preconditionerType ( )

inlinevirtual

Return the name of the preconditioner.

Returns: "AztecOO"

Implements Preconditioner.

Definition at line 156 of file PreconditionerAztecOO.hpp.

Field Documentation

◆ M_solver

Solver_Type* M_solver

private

Definition at line 165 of file PreconditionerAztecOO.hpp.

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

Private Attributes

Public Types

Constructors & Destructor

Methods

Set Methods

Get Methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ super

◆ operator_raw_type

◆ operator_type

◆ Solver_Type

Constructor & Destructor Documentation

◆ PreconditionerAztecOO()

◆ ~PreconditionerAztecOO()

Member Function Documentation

◆ buildPreconditioner()

◆ resetPreconditioner()

◆ createParametersList()

◆ showMe()

◆ condest()

◆ setDataFromGetPot()

◆ setSolver()

◆ preconditioner()

◆ preconditionerPtr()

◆ preconditionerType()

Field Documentation

◆ M_solver