#include <BelosBottomSolver.h>

Inheritance diagram for BelosBottomSolver< Level >:

Collaboration diagram for BelosBottomSolver< Level >:

Public Types
typedef amr::matrix_t	matrix_t
typedef amr::vector_t	vector_t
typedef amr::scalar_t	scalar_t
typedef amr::multivector_t	mv_t
typedef amr::operator_t	op_t
typedef amr::local_ordinal_t	lo_t
typedef amr::global_ordinal_t	go_t
typedef amr::node_t	node_t
typedef Belos::SolverManager< scalar_t, mv_t, op_t >	solver_t
typedef Belos::LinearProblem< scalar_t, mv_t, op_t >	problem_t
typedef AmrPreconditioner< matrix_t, Level >	prec_t

Public Member Functions
	BelosBottomSolver (std::string solvertype="Pseudoblock CG", const std::shared_ptr< prec_t > &prec_p=nullptr)
void	solve (const Teuchos::RCP< mv_t > &x, const Teuchos::RCP< mv_t > &b)
void	setOperator (const Teuchos::RCP< matrix_t > &A, Level *level_p=nullptr)
std::size_t	getNumIters ()
virtual void	solve (const Teuchos::RCP< amr::multivector_t > &x, const Teuchos::RCP< amr::multivector_t > &b)=0
virtual void	setOperator (const Teuchos::RCP< amr::matrix_t > &A, Level *level_p=nullptr)=0
bool	hasOperator () const

Protected Attributes
bool	isInitialized_m

Private Member Functions
void	initSolver_m (std::string solvertype)

Private Attributes
Teuchos::RCP< problem_t >	problem_mp
	represents linear problem
Teuchos::RCP< Teuchos::ParameterList >	params_mp
	parameter list of solver
Teuchos::RCP< solver_t >	solver_mp
	solver instance
std::shared_ptr< prec_t >	prec_mp
	preconditioner
Teuchos::RCP< matrix_t >	A_mp
	copy of matrix (has to be positive definite)
scalar_t	reltol_m
	relative tolerance
int	maxiter_m
	allowed number of steps for iterative solvers

Detailed Description

template<class Level>
class BelosBottomSolver< Level >

Definition at line 35 of file BelosBottomSolver.h.

Member Typedef Documentation

◆ go_t

template<class Level>

typedef amr::global_ordinal_t BelosBottomSolver< Level >::go_t

Definition at line 46 of file BelosBottomSolver.h.

◆ lo_t

template<class Level>

typedef amr::local_ordinal_t BelosBottomSolver< Level >::lo_t

Definition at line 45 of file BelosBottomSolver.h.

◆ matrix_t

template<class Level>

typedef amr::matrix_t BelosBottomSolver< Level >::matrix_t

Definition at line 40 of file BelosBottomSolver.h.

◆ mv_t

template<class Level>

typedef amr::multivector_t BelosBottomSolver< Level >::mv_t

Definition at line 43 of file BelosBottomSolver.h.

◆ node_t

template<class Level>

typedef amr::node_t BelosBottomSolver< Level >::node_t

Definition at line 47 of file BelosBottomSolver.h.

◆ op_t

template<class Level>

typedef amr::operator_t BelosBottomSolver< Level >::op_t

Definition at line 44 of file BelosBottomSolver.h.

◆ prec_t

template<class Level>

typedef AmrPreconditioner<matrix_t, Level> BelosBottomSolver< Level >::prec_t

Definition at line 52 of file BelosBottomSolver.h.

◆ problem_t

template<class Level>

typedef Belos::LinearProblem<scalar_t, mv_t, op_t> BelosBottomSolver< Level >::problem_t

Definition at line 50 of file BelosBottomSolver.h.

◆ scalar_t

template<class Level>

typedef amr::scalar_t BelosBottomSolver< Level >::scalar_t

Definition at line 42 of file BelosBottomSolver.h.

◆ solver_t

template<class Level>

typedef Belos::SolverManager<scalar_t, mv_t, op_t> BelosBottomSolver< Level >::solver_t

Definition at line 49 of file BelosBottomSolver.h.

◆ vector_t

template<class Level>

typedef amr::vector_t BelosBottomSolver< Level >::vector_t

Definition at line 41 of file BelosBottomSolver.h.

Constructor & Destructor Documentation

◆ BelosBottomSolver()

template<class Level>

BelosBottomSolver< Level >::BelosBottomSolver	(	std::string	solvertype = "Pseudoblock CG",
		const std::shared_ptr< prec_t > &	prec_p = nullptr )

Parameters

solvertype	to use
precond	preconditioner of matrix

Definition at line 27 of file BelosBottomSolver.hpp.

References A_mp, BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >::BottomSolver(), initSolver_m(), maxiter_m, prec_mp, problem_mp, and reltol_m.

Here is the call graph for this function:

Member Function Documentation

◆ getNumIters()

template<class Level>

std::size_t BelosBottomSolver< Level >::getNumIters ( )

virtual

Returns: the number of required iterations

Implements BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >.

Definition at line 100 of file BelosBottomSolver.hpp.

References solver_mp.

◆ hasOperator()

bool BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >::hasOperator ( ) const

inherited

Definition at line 59 of file BottomSolver.h.

◆ initSolver_m()

template<class Level>

void BelosBottomSolver< Level >::initSolver_m ( std::string solvertype )

private

Create a solver instance

Parameters

solvertype to create

Definition at line 110 of file BelosBottomSolver.hpp.

References maxiter_m, params_mp, reltol_m, and solver_mp.

Referenced by BelosBottomSolver().

◆ setOperator() [1/2]

template<class Level>

void BelosBottomSolver< Level >::setOperator	(	const Teuchos::RCP< matrix_t > &	A,
		Level *	level_p = nullptr )

Definition at line 71 of file BelosBottomSolver.hpp.

References A_mp, IpplTimings::getTimer(), BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >::isInitialized_m, prec_mp, problem_mp, IpplTimings::startTimer(), and IpplTimings::stopTimer().

Here is the call graph for this function:

◆ setOperator() [2/2]

virtual void BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >::setOperator	(	const Teuchos::RCP< amr::matrix_t > &	A,
		Level *	level_p = nullptr )

pure virtualinherited

Set the system matrix

Parameters

A	system matrix

◆ solve() [1/2]

template<class Level>

void BelosBottomSolver< Level >::solve	(	const Teuchos::RCP< mv_t > &	x,
		const Teuchos::RCP< mv_t > &	b )

Definition at line 43 of file BelosBottomSolver.hpp.

References endl(), gmsg, problem_mp, and solver_mp.

Here is the call graph for this function:

◆ solve() [2/2]

virtual void BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >::solve	(	const Teuchos::RCP< amr::multivector_t > &	x,
		const Teuchos::RCP< amr::multivector_t > &	b )

pure virtualinherited

Solves

\[ Ax = b \]

Parameters

x	left-hand side
b	right-hand side

Member Data Documentation

◆ A_mp

template<class Level>

Teuchos::RCP<matrix_t> BelosBottomSolver< Level >::A_mp

private

copy of matrix (has to be positive definite)

Definition at line 83 of file BelosBottomSolver.h.

Referenced by BelosBottomSolver(), and setOperator().

◆ isInitialized_m

bool BottomSolver< Teuchos::RCP< amr::matrix_t >, Teuchos::RCP< amr::multivector_t >, Level >::isInitialized_m

protectedinherited

Definition at line 63 of file BottomSolver.h.

Referenced by Amesos2BottomSolver< Level >::setOperator(), BelosBottomSolver< Level >::setOperator(), and MueLuBottomSolver< Level >::setOperator().

◆ maxiter_m

template<class Level>

int BelosBottomSolver< Level >::maxiter_m

private

allowed number of steps for iterative solvers

Definition at line 88 of file BelosBottomSolver.h.

Referenced by BelosBottomSolver(), and initSolver_m().

◆ params_mp

template<class Level>

Teuchos::RCP<Teuchos::ParameterList> BelosBottomSolver< Level >::params_mp

private

parameter list of solver

Definition at line 80 of file BelosBottomSolver.h.

Referenced by initSolver_m().

◆ prec_mp

template<class Level>

std::shared_ptr<prec_t> BelosBottomSolver< Level >::prec_mp

private

preconditioner

Definition at line 82 of file BelosBottomSolver.h.

Referenced by BelosBottomSolver(), and setOperator().

◆ problem_mp

template<class Level>

Teuchos::RCP<problem_t> BelosBottomSolver< Level >::problem_mp

private

represents linear problem

Definition at line 79 of file BelosBottomSolver.h.

Referenced by BelosBottomSolver(), setOperator(), and solve().

◆ reltol_m

template<class Level>

scalar_t BelosBottomSolver< Level >::reltol_m

private

relative tolerance

Definition at line 85 of file BelosBottomSolver.h.

Referenced by BelosBottomSolver(), and initSolver_m().

◆ solver_mp

template<class Level>

Teuchos::RCP<solver_t> BelosBottomSolver< Level >::solver_mp

private

solver instance

Definition at line 81 of file BelosBottomSolver.h.

Referenced by getNumIters(), initSolver_m(), and solve().

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

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ go_t

◆ lo_t

◆ matrix_t

◆ mv_t

◆ node_t

◆ op_t

◆ prec_t

◆ problem_t

◆ scalar_t

◆ solver_t

◆ vector_t

Constructor & Destructor Documentation

◆ BelosBottomSolver()

Member Function Documentation

◆ getNumIters()

◆ hasOperator()

◆ initSolver_m()

◆ setOperator() [1/2]

◆ setOperator() [2/2]

◆ solve() [1/2]

◆ solve() [2/2]

Member Data Documentation

◆ A_mp

◆ isInitialized_m

◆ maxiter_m

◆ params_mp

◆ prec_mp

◆ problem_mp

◆ reltol_m

◆ solver_mp