MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::Details::LinearSolver< MV, OP, NormType > Class Template Reference

#include <MueLu_Details_LinearSolverFactory_def.hpp>

Inheritance diagram for MueLu::Details::LinearSolver< MV, OP, NormType >:

Public Member Functions

 LinearSolver ()
 Constructor.
 
virtual ~LinearSolver ()
 Destructor (virtual for memory safety).
 
void setMatrix (const Teuchos::RCP< const OP > &A)
 Set the Solver's matrix.
 
Teuchos::RCP< const OP > getMatrix () const
 Get a pointer to this Solver's matrix.
 
void solve (MV &X, const MV &B)
 Solve the linear system(s) AX=B.
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params)
 Set this solver's parameters.
 
void symbolic ()
 Set up any part of the solve that depends on the structure of the input matrix, but not its numerical values.
 
void numeric ()
 Set up any part of the solve that depends on both the structure and the numerical values of the input matrix.
 
std::string description () const
 Implementation of Teuchos::Describable::description.
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Implementation of Teuchos::Describable::describe.
 

Private Attributes

Teuchos::RCP< const OP > A_
 
Teuchos::RCP< Teuchos::ParameterList > params_
 

Detailed Description

template<class MV, class OP, class NormType>
class MueLu::Details::LinearSolver< MV, OP, NormType >

Definition at line 71 of file MueLu_Details_LinearSolverFactory_def.hpp.

Constructor & Destructor Documentation

◆ LinearSolver()

template<class MV , class OP , class NormType >
MueLu::Details::LinearSolver< MV, OP, NormType >::LinearSolver ( )
inline

Constructor.

Definition at line 79 of file MueLu_Details_LinearSolverFactory_def.hpp.

◆ ~LinearSolver()

template<class MV , class OP , class NormType >
virtual MueLu::Details::LinearSolver< MV, OP, NormType >::~LinearSolver ( )
inlinevirtual

Destructor (virtual for memory safety).

Definition at line 82 of file MueLu_Details_LinearSolverFactory_def.hpp.

Member Function Documentation

◆ setMatrix()

template<class MV , class OP , class NormType >
void MueLu::Details::LinearSolver< MV, OP, NormType >::setMatrix ( const Teuchos::RCP< const OP > & A)

Set the Solver's matrix.

Parameters
A[in] Pointer to the matrix A in the linear system(s) AX=B to solve.

◆ getMatrix()

template<class MV , class OP , class NormType >
Teuchos::RCP< const OP > MueLu::Details::LinearSolver< MV, OP, NormType >::getMatrix ( ) const
inline

Get a pointer to this Solver's matrix.

Definition at line 91 of file MueLu_Details_LinearSolverFactory_def.hpp.

◆ solve()

template<class MV , class OP , class NormType >
void MueLu::Details::LinearSolver< MV, OP, NormType >::solve ( MV & X,
const MV & B )

Solve the linear system(s) AX=B.

◆ setParameters()

template<class MV , class OP , class NormType >
void MueLu::Details::LinearSolver< MV, OP, NormType >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > & params)

Set this solver's parameters.

◆ symbolic()

template<class MV , class OP , class NormType >
void MueLu::Details::LinearSolver< MV, OP, NormType >::symbolic ( )
inline

Set up any part of the solve that depends on the structure of the input matrix, but not its numerical values.

Definition at line 103 of file MueLu_Details_LinearSolverFactory_def.hpp.

◆ numeric()

template<class MV , class OP , class NormType >
void MueLu::Details::LinearSolver< MV, OP, NormType >::numeric ( )

Set up any part of the solve that depends on both the structure and the numerical values of the input matrix.

◆ description()

template<class MV , class OP , class NormType >
std::string MueLu::Details::LinearSolver< MV, OP, NormType >::description ( ) const

Implementation of Teuchos::Describable::description.

◆ describe()

template<class MV , class OP , class NormType >
void MueLu::Details::LinearSolver< MV, OP, NormType >::describe ( Teuchos::FancyOStream & out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default ) const

Implementation of Teuchos::Describable::describe.

Member Data Documentation

◆ A_

template<class MV , class OP , class NormType >
Teuchos::RCP<const OP> MueLu::Details::LinearSolver< MV, OP, NormType >::A_
private

Definition at line 119 of file MueLu_Details_LinearSolverFactory_def.hpp.

◆ params_

template<class MV , class OP , class NormType >
Teuchos::RCP<Teuchos::ParameterList> MueLu::Details::LinearSolver< MV, OP, NormType >::params_
private

Definition at line 120 of file MueLu_Details_LinearSolverFactory_def.hpp.


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