Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
B::Solver3< MV, OP, NormType > Class Template Reference

#include <PackageB.hpp>

Inheritance diagram for B::Solver3< MV, OP, NormType >:
Inheritance graph
[legend]

Public Member Functions

virtual ~Solver3 ()
 
void solve (MV &, const MV &)
 Solve the linear system(s) AX=B. More...
 
- Public Member Functions inherited from Common::LinearSolverTestBase< MV, OP, NormType >
virtual ~LinearSolverTestBase ()
 
void setMatrix (const Teuchos::RCP< const OP > &A)
 Set the solver's matrix. More...
 
Teuchos::RCP< const OP > getMatrix () const
 Get a pointer to this solver's matrix. More...
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &)
 Set this solver's parameters. More...
 
void symbolic ()
 Set up any part of the solve that depends on the structure of the input matrix, but not its numerical values. More...
 
void numeric ()
 Set up any part of the solve that depends on both the structure and the numerical values of the input matrix. More...
 
- Public Member Functions inherited from Trilinos::Details::LinearSolver< MV, OP, NormType >
virtual ~LinearSolver ()
 Destructor (virtual for memory safety of derived classes). More...
 

Protected Member Functions

std::string name () const
 

Detailed Description

template<class MV, class OP, class NormType>
class B::Solver3< MV, OP, NormType >

Definition at line 25 of file PackageB.hpp.

Constructor & Destructor Documentation

template<class MV , class OP , class NormType >
virtual B::Solver3< MV, OP, NormType >::~Solver3 ( )
inlinevirtual

Definition at line 32 of file PackageB.hpp.

Member Function Documentation

template<class MV , class OP , class NormType >
std::string B::Solver3< MV, OP, NormType >::name ( ) const
inlineprotectedvirtual

Implements Common::LinearSolverTestBase< MV, OP, NormType >.

Definition at line 27 of file PackageB.hpp.

template<class MV , class OP , class NormType >
void B::Solver3< MV, OP, NormType >::solve ( MV &  X,
const MV &  B 
)
inlinevirtual

Solve the linear system(s) AX=B.

Parameters
X[in/out] On input: (multi)vector that is allocated and ready for output. The solver may choose to read the contents as the initial guess(es). On output: the solution vector(s).
B[in] Right-hand side(s) of the linear system(s).

Solves may fail. "Failure" depends on the accuracy that the specific solver promises. The caller is responsible for determining whether the solve succeeded. This may require a dynamic cast to ask the specific kind of solver whether it succeeded, or testing some error metric (like the the residual 2-norm).

Implements Trilinos::Details::LinearSolver< MV, OP, NormType >.

Definition at line 34 of file PackageB.hpp.


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