Stratimikos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
Thyra::BelosTpetraKrylov< SC, MV, OP > Class Template Referenceabstract

#include <Thyra_BelosTpetrasSolverAdapter.hpp>

Inheritance diagram for Thyra::BelosTpetraKrylov< SC, MV, OP >:
Inheritance graph
[legend]

Public Types

using tpetra_base_solver_type = BelosTpetra::Impl::Krylov< SC >
 
using converter = Thyra::TpetraOperatorVectorExtraction< SC >
 

Public Member Functions

 BelosTpetraKrylov ()=default
 constructor
 
virtual Teuchos::RCP< Belos::SolverManager< SC, MV, OP > > clone () const override=0
 clone for Inverted Injection (DII)
 
void setProblem (const Teuchos::RCP< Belos::LinearProblem< SC, MV, OP > > &problem) override
 set/get problem
 
const Belos::LinearProblem< SC, MV, OP > & getProblem () const override
 
void setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params) override
 set/get parameters
 
Teuchos::RCP< const Teuchos::ParameterList > getCurrentParameters () const override
 
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters () const override
 
int getNumIters () const override
 Get the iteration count for the most recent call to solve().
 
bool isLOADetected () const override
 
void reset (const Belos::ResetType type) override
 
Teuchos::ScalarTraits< SC >::magnitudeType achievedTol () const
 
Belos::ReturnType solve () override
 solve
 

Protected Attributes

Teuchos::RCP< tpetra_base_solver_typetpetra_solver
 
BelosTpetra::Impl::SolverOutput< SC > solver_output
 
Teuchos::RCP< Teuchos::ParameterList > params_
 Current parameter list.
 
Teuchos::RCP< Belos::LinearProblem< SC, MV, OP > > problem_
 The linear problem to solve.
 

Detailed Description

template<class SC, class MV, class OP>
class Thyra::BelosTpetraKrylov< SC, MV, OP >

Definition at line 70 of file Thyra_BelosTpetrasSolverAdapter.hpp.

Member Typedef Documentation

◆ tpetra_base_solver_type

template<class SC , class MV , class OP >
using Thyra::BelosTpetraKrylov< SC, MV, OP >::tpetra_base_solver_type = BelosTpetra::Impl::Krylov<SC>

Definition at line 72 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ converter

template<class SC , class MV , class OP >
using Thyra::BelosTpetraKrylov< SC, MV, OP >::converter = Thyra::TpetraOperatorVectorExtraction<SC>

Definition at line 73 of file Thyra_BelosTpetrasSolverAdapter.hpp.

Constructor & Destructor Documentation

◆ BelosTpetraKrylov()

template<class SC , class MV , class OP >
Thyra::BelosTpetraKrylov< SC, MV, OP >::BelosTpetraKrylov ( )
default

constructor

Member Function Documentation

◆ clone()

template<class SC , class MV , class OP >
virtual Teuchos::RCP< Belos::SolverManager< SC, MV, OP > > Thyra::BelosTpetraKrylov< SC, MV, OP >::clone ( ) const
overridepure virtual

◆ setProblem()

template<class SC , class MV , class OP >
void Thyra::BelosTpetraKrylov< SC, MV, OP >::setProblem ( const Teuchos::RCP< Belos::LinearProblem< SC, MV, OP > > &  problem)
inlineoverride

set/get problem

Definition at line 82 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ getProblem()

template<class SC , class MV , class OP >
const Belos::LinearProblem< SC, MV, OP > & Thyra::BelosTpetraKrylov< SC, MV, OP >::getProblem ( ) const
inlineoverride

Definition at line 86 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ setParameters()

template<class SC , class MV , class OP >
void Thyra::BelosTpetraKrylov< SC, MV, OP >::setParameters ( const Teuchos::RCP< Teuchos::ParameterList > &  params)
inlineoverride

set/get parameters

Definition at line 91 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ getCurrentParameters()

template<class SC , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Thyra::BelosTpetraKrylov< SC, MV, OP >::getCurrentParameters ( ) const
inlineoverride

Definition at line 96 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ getValidParameters()

template<class SC , class MV , class OP >
Teuchos::RCP< const Teuchos::ParameterList > Thyra::BelosTpetraKrylov< SC, MV, OP >::getValidParameters ( ) const
inlineoverride

Definition at line 100 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ getNumIters()

template<class SC , class MV , class OP >
int Thyra::BelosTpetraKrylov< SC, MV, OP >::getNumIters ( ) const
inlineoverride

Get the iteration count for the most recent call to solve().

Definition at line 111 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ isLOADetected()

template<class SC , class MV , class OP >
bool Thyra::BelosTpetraKrylov< SC, MV, OP >::isLOADetected ( ) const
inlineoverride

Definition at line 112 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ reset()

template<class SC , class MV , class OP >
void Thyra::BelosTpetraKrylov< SC, MV, OP >::reset ( const Belos::ResetType  type)
inlineoverride

Definition at line 113 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ achievedTol()

template<class SC , class MV , class OP >
Teuchos::ScalarTraits< SC >::magnitudeType Thyra::BelosTpetraKrylov< SC, MV, OP >::achievedTol ( ) const
inline

Definition at line 118 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ solve()

template<class SC , class MV , class OP >
Belos::ReturnType Thyra::BelosTpetraKrylov< SC, MV, OP >::solve ( )
inlineoverride

solve

Definition at line 123 of file Thyra_BelosTpetrasSolverAdapter.hpp.

Member Data Documentation

◆ tpetra_solver

template<class SC , class MV , class OP >
Teuchos::RCP<tpetra_base_solver_type> Thyra::BelosTpetraKrylov< SC, MV, OP >::tpetra_solver
protected

Definition at line 153 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ solver_output

template<class SC , class MV , class OP >
BelosTpetra::Impl::SolverOutput<SC> Thyra::BelosTpetraKrylov< SC, MV, OP >::solver_output
protected

Definition at line 154 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ params_

template<class SC , class MV , class OP >
Teuchos::RCP<Teuchos::ParameterList> Thyra::BelosTpetraKrylov< SC, MV, OP >::params_
protected

Current parameter list.

Definition at line 157 of file Thyra_BelosTpetrasSolverAdapter.hpp.

◆ problem_

template<class SC , class MV , class OP >
Teuchos::RCP<Belos::LinearProblem<SC, MV, OP> > Thyra::BelosTpetraKrylov< SC, MV, OP >::problem_
protected

The linear problem to solve.

Definition at line 160 of file Thyra_BelosTpetrasSolverAdapter.hpp.


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