PreconditionerLinearSolver - Class to wrap linear solver. More...

#include <PreconditionerLinearSolver.hpp>

Inheritance diagram for PreconditionerLinearSolver:

Collaboration diagram for PreconditionerLinearSolver:

Private Attributes
solverPtr_Type	M_solver

preconditionerPtr_Type	M_preconditioner

GetPot	M_dataFile

bool	M_printSubiterationCount

std::string	M_precName

std::string	M_precDataSection

Public Types
typedef Epetra_Operator	prec_raw_type

typedef std::shared_ptr< prec_raw_type >	prec_type

typedef LinearSolver	solver_Type

typedef std::shared_ptr< solver_Type >	solverPtr_Type

typedef MatrixEpetra< Real >	operator_raw_type

typedef std::shared_ptr< operator_raw_type >	operator_type

typedef Preconditioner	preconditioner_Type

typedef std::shared_ptr< preconditioner_Type >	preconditionerPtr_Type

typedef Displayer::comm_Type	comm_Type

typedef Displayer::commPtr_Type	commPtr_Type

typedef Teuchos::ParameterList	list_Type

Constructors & Destructor
	PreconditionerLinearSolver (std::shared_ptr< Epetra_Comm > comm=std::shared_ptr< Epetra_Comm >(new Epetra_MpiComm(MPI_COMM_WORLD)))
	Default constructor. More...

virtual	~PreconditionerLinearSolver ()
	Destructor. More...

Methods
virtual 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 Int	buildPreconditioner (operator_type &matrix)
	Build a preconditioner based on the given matrix. More...

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

virtual Real	condest ()
	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...

static void	createLinearSolverList (list_Type &list, const GetPot &dataFile, const std::string &section, const std::string &subSection="SolverLinear", const bool &verbose=true)
	Create the list of parameters of the preconditioner. More...

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

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

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

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

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

const Epetra_Map &	OperatorDomainMap () const
	Return the Domain map of the operator. 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 &)
	Set the internal solver. More...

Get Methods
bool	isPreconditionerSet () const
	Return true if the preconditioner is set. More...

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

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

solverPtr_Type	solverPtr ()
	Return a shared pointer on the solver. More...

std::string	preconditionerType ()
	Return the type of 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...

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

PreconditionerLinearSolver - Class to wrap linear solver.

Author: Gwenol Grandperrin gweno.nosp@m.l.gr.nosp@m.andpe.nosp@m.rrin.nosp@m.@epfl.nosp@m..ch

Definition at line 63 of file PreconditionerLinearSolver.hpp.

Member Typedef Documentation

◆ prec_raw_type

typedef Epetra_Operator prec_raw_type

Definition at line 71 of file PreconditionerLinearSolver.hpp.

◆ prec_type

typedef std::shared_ptr<prec_raw_type> prec_type

Definition at line 72 of file PreconditionerLinearSolver.hpp.

◆ solver_Type

typedef LinearSolver solver_Type

Definition at line 74 of file PreconditionerLinearSolver.hpp.

◆ solverPtr_Type

typedef std::shared_ptr<solver_Type> solverPtr_Type

Definition at line 75 of file PreconditionerLinearSolver.hpp.

◆ operator_raw_type

typedef MatrixEpetra<Real> operator_raw_type

Definition at line 77 of file PreconditionerLinearSolver.hpp.

◆ operator_type

typedef std::shared_ptr<operator_raw_type> operator_type

Definition at line 78 of file PreconditionerLinearSolver.hpp.

◆ preconditioner_Type

typedef Preconditioner preconditioner_Type

Definition at line 80 of file PreconditionerLinearSolver.hpp.

◆ preconditionerPtr_Type

typedef std::shared_ptr<preconditioner_Type> preconditionerPtr_Type

Definition at line 81 of file PreconditionerLinearSolver.hpp.

◆ comm_Type

typedef Displayer::comm_Type comm_Type

Definition at line 83 of file PreconditionerLinearSolver.hpp.

◆ commPtr_Type

typedef Displayer::commPtr_Type commPtr_Type

Definition at line 84 of file PreconditionerLinearSolver.hpp.

◆ list_Type

typedef Teuchos::ParameterList list_Type

Definition at line 86 of file PreconditionerLinearSolver.hpp.

Constructor & Destructor Documentation

◆ PreconditionerLinearSolver()

PreconditionerLinearSolver ( std::shared_ptr< Epetra_Comm > comm = std::shared_ptr<Epetra_Comm> ( new Epetra_MpiComm ( MPI_COMM_WORLD ) ) )

Default constructor.

Parameters

comm	The communicator.

Definition at line 48 of file PreconditionerLinearSolver.cpp.

◆ ~PreconditionerLinearSolver()

~PreconditionerLinearSolver ( )

virtual

Destructor.

Definition at line 57 of file PreconditionerLinearSolver.cpp.

Member Function Documentation

◆ 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 68 of file PreconditionerLinearSolver.cpp.

◆ createLinearSolverList()

void createLinearSolverList	(	list_Type &	list,
		const GetPot &	dataFile,
		const std::string &	section,
		const std::string &	subSection = `"SolverLinear"`,
		const bool &	verbose = `true`
	)

static

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

Definition at line 77 of file PreconditionerLinearSolver.cpp.