Stratimikos Package Browser (Single Doxygen Collection): Thyra::BelosTpetraKrylov< SC, MV, OP > Class Template Reference

Stratimikos Package Browser (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

#include <Thyra_BelosTpetrasSolverAdapter.hpp>

Inheritance diagram for Thyra::BelosTpetraKrylov< SC, MV, OP >:

Inheritance graph

Public Types
using	tpetra_base_solver_type = BelosTpetra::Impl::Krylov< SC >

using	converter = Thyra::TpetraOperatorVectorExtraction< SC >

Public Member Functions
	BelosTpetraKrylov ()=default
	constructor More...

virtual Teuchos::RCP < Belos::SolverManager< SC, MV, OP > >	clone () const override=0
	clone for Inverted Injection (DII) More...

void	setProblem (const Teuchos::RCP< Belos::LinearProblem< SC, MV, OP > > &problem) override
	set/get problem More...

const Belos::LinearProblem< SC, MV, OP > &	getProblem () const override

void	setParameters (const Teuchos::RCP< Teuchos::ParameterList > &params) override
	set/get parameters More...

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()`. More...

bool	isLOADetected () const override

void	reset (const Belos::ResetType type) override

Teuchos::ScalarTraits< SC > ::magnitudeType	achievedTol () const override

Belos::ReturnType	solve () override
	solve More...

Protected Attributes
Teuchos::RCP < tpetra_base_solver_type >	tpetra_solver

BelosTpetra::Impl::SolverOutput < SC >	solver_output

Teuchos::RCP < Teuchos::ParameterList >	params_
	Current parameter list. More...

Teuchos::RCP < Belos::LinearProblem< SC, MV, OP > >	problem_
	The linear problem to solve. More...

Detailed Description

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

Definition at line 38 of file Thyra_BelosTpetrasSolverAdapter.hpp.

Member Typedef Documentation

template<class SC , class MV , class OP >

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

Definition at line 40 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

Definition at line 41 of file Thyra_BelosTpetrasSolverAdapter.hpp.

Constructor & Destructor Documentation

template<class SC , class MV , class OP >

Thyra::BelosTpetraKrylov< SC, MV, OP >::BelosTpetraKrylov ( )

default

constructor

Member Function Documentation

template<class SC , class MV , class OP >

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

overridepure virtual

clone for Inverted Injection (DII)

Implemented in Thyra::BelosTpetraGmresSstep< SC, MV, OP >, Thyra::BelosTpetraGmresSingleReduce< SC, MV, OP >, Thyra::BelosTpetraGmresPipeline< SC, MV, OP >, and Thyra::BelosTpetraGmres< SC, MV, OP >.

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 50 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

Definition at line 54 of file Thyra_BelosTpetrasSolverAdapter.hpp.

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 59 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

Definition at line 64 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

Definition at line 68 of file Thyra_BelosTpetrasSolverAdapter.hpp.

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 79 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

Definition at line 80 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

Definition at line 81 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

Definition at line 86 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

inlineoverride

solve

Definition at line 91 of file Thyra_BelosTpetrasSolverAdapter.hpp.

Member Data Documentation

template<class SC , class MV , class OP >

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

protected

Definition at line 121 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

protected

Definition at line 122 of file Thyra_BelosTpetrasSolverAdapter.hpp.

template<class SC , class MV , class OP >

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

protected

Current parameter list.

Definition at line 125 of file Thyra_BelosTpetrasSolverAdapter.hpp.

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 128 of file Thyra_BelosTpetrasSolverAdapter.hpp.

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

Thyra_BelosTpetrasSolverAdapter.hpp