Reference documentation for deal.II version 8.1.0
Classes | Public Types | Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | List of all members
TrilinosWrappers::SolverBase Class Reference

#include <trilinos_solver.h>

Inheritance diagram for TrilinosWrappers::SolverBase:
[legend]

Classes

struct  AdditionalData
 

Public Types

enum  SolverName {
  cg, cgs, gmres, bicgstab,
  tfqmr
}
 

Public Member Functions

 SolverBase (SolverControl &cn)
 
 SolverBase (const enum SolverName solver_name, SolverControl &cn)
 
virtual ~SolverBase ()
 
void solve (const SparseMatrix &A, VectorBase &x, const VectorBase &b, const PreconditionBase &preconditioner)
 
void solve (Epetra_Operator &A, VectorBase &x, const VectorBase &b, const PreconditionBase &preconditioner)
 
void solve (const SparseMatrix &A,::Vector< double > &x, const ::Vector< double > &b, const PreconditionBase &preconditioner)
 
void solve (Epetra_Operator &A,::Vector< double > &x, const ::Vector< double > &b, const PreconditionBase &preconditioner)
 
SolverControlcontrol () const
 
 DeclException1 (ExcTrilinosError, int,<< "An error with error number "<< arg1<< " occurred while calling a Trilinos function")
 

Public Attributes

enum TrilinosWrappers::SolverBase::SolverName solver_name
 

Protected Attributes

SolverControlsolver_control
 

Private Member Functions

void execute_solve (const PreconditionBase &preconditioner)
 

Private Attributes

std_cxx1x::shared_ptr< Epetra_LinearProblem > linear_problem
 
AztecOO solver
 
const AdditionalData additional_data
 

Detailed Description

Base class for solver classes using the Trilinos solvers. Since solvers in Trilinos are selected based on flags passed to a generic solver object, basically all the actual solver calls happen in this class, and derived classes simply set the right flags to select one solver or another, or to set certain parameters for individual solvers. For a general discussion on the Trilinos solver package AztecOO, we refer to the AztecOO user guide.

This solver class can also be used as a standalone class, where the respective Krylov method is set via the flag solver_name. This can be done at runtime (e.g., when parsing the solver from a ParameterList) and is similar to the deal.II class SolverSelector.

Author
Martin Kronbichler, 2008, 2009

Definition at line 65 of file trilinos_solver.h.

Constructor & Destructor Documentation

TrilinosWrappers::SolverBase::SolverBase ( SolverControl cn)

Constructor. Takes the solver control object and creates the solver.

TrilinosWrappers::SolverBase::SolverBase ( const enum SolverName  solver_name,
SolverControl cn 
)

Second constructor. This constructor takes an enum object that specifies the solver name and sets the appropriate Krylov method.

virtual TrilinosWrappers::SolverBase::~SolverBase ( )
virtual

Destructor.

Member Function Documentation

void TrilinosWrappers::SolverBase::solve ( const SparseMatrix A,
VectorBase x,
const VectorBase b,
const PreconditionBase preconditioner 
)

Solve the linear system Ax=b. Depending on the information provided by derived classes and the object passed as a preconditioner, one of the linear solvers and preconditioners of Trilinos is chosen.

void TrilinosWrappers::SolverBase::solve ( Epetra_Operator &  A,
VectorBase x,
const VectorBase b,
const PreconditionBase preconditioner 
)

Solve the linear system Ax=b where A is an operator. This function can be used for matrix free computation. Depending on the information provided by derived classes and the object passed as a preconditioner, one of the linear solvers and preconditioners of Trilinos is chosen.

void TrilinosWrappers::SolverBase::solve ( const SparseMatrix A,
::Vector< double > &  x,
const ::Vector< double > &  b,
const PreconditionBase preconditioner 
)

Solve the linear system Ax=b. Depending on the information provided by derived classes and the object passed as a preconditioner, one of the linear solvers and preconditioners of Trilinos is chosen. This class works with matrices according to the TrilinosWrappers format, but can take deal.II vectors as argument. Since deal.II are serial vectors (not distributed), this function does only what you expect in case the matrix is locally owned. Otherwise, an exception will be thrown.

void TrilinosWrappers::SolverBase::solve ( Epetra_Operator &  A,
::Vector< double > &  x,
const ::Vector< double > &  b,
const PreconditionBase preconditioner 
)

Solve the linear system Ax=b where A is an operator. This function can be used for matric free. Depending on the information provided by derived classes and the object passed as a preconditioner, one of the linear solvers and preconditioners of Trilinos is chosen. This class works with matrices according to the TrilinosWrappers format, but can take deal.II vectors as argument. Since deal.II are serial vectors (not distributed), this function does only what you expect in case the matrix is locally owned. Otherwise, an exception will be thrown.

SolverControl& TrilinosWrappers::SolverBase::control ( ) const

Access to object that controls convergence.

TrilinosWrappers::SolverBase::DeclException1 ( ExcTrilinosError  ,
int  ,
<< "An error with error number "<< arg1<< " occurred while calling a Trilinos function"   
)

Exception

void TrilinosWrappers::SolverBase::execute_solve ( const PreconditionBase preconditioner)
private

The solve function is used to set properly the Epetra_LinearProblem, once it is done this function solves the linear problem.

Member Data Documentation

SolverControl& TrilinosWrappers::SolverBase::solver_control
protected

Reference to the object that controls convergence of the iterative solver. In fact, for these Trilinos wrappers, Trilinos does so itself, but we copy the data from this object before starting the solution process, and copy the data back into it afterwards.

Definition at line 261 of file trilinos_solver.h.

std_cxx1x::shared_ptr<Epetra_LinearProblem> TrilinosWrappers::SolverBase::linear_problem
private

A structure that collects the Trilinos sparse matrix, the right hand side vector and the solution vector, which is passed down to the Trilinos solver.

Definition at line 279 of file trilinos_solver.h.

AztecOO TrilinosWrappers::SolverBase::solver
private

A structure that contains the Trilinos solver and preconditioner objects.

Definition at line 286 of file trilinos_solver.h.

const AdditionalData TrilinosWrappers::SolverBase::additional_data
private

Store a copy of the flags for this particular solver.

Definition at line 292 of file trilinos_solver.h.


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