MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Base class for energy-minimization iterative solvers. More...

#include <MueLu_SolverBase.hpp>

Inheritance diagram for MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Member Functions
	SolverBase ()
virtual	~SolverBase ()
Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor.
Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()
virtual	~VerboseObject ()
	Destructor.
VerbLevel	GetVerbLevel () const
	Get the verbosity level.
void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object.
int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose.
int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing.
bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type.
Teuchos::FancyOStream &	GetOStream (MsgType type, int thisProcRankOnly=0) const
	Get an output stream for outputting the input message type.
Teuchos::FancyOStream &	GetBlackHole () const
Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor.
virtual void	describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
virtual std::string	description () const
	Return a simple one-line description of this object.
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object.
virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace.

Iterate methods.
virtual void	Iterate (const Matrix &A, const Constraint &C, const Matrix &P0, RCP< Matrix > &P) const =0

Additional Inherited Members
Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level.
static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level.
static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
static void	SetMueLuOFileStream (const std::string &filename)
static Teuchos::RCP< Teuchos::FancyOStream >	GetMueLuOStream ()

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Base class for energy-minimization iterative solvers.

Definition at line 31 of file MueLu_SolverBase.hpp.

Constructor & Destructor Documentation

SolverBase()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SolverBase ( )

inline

Definition at line 37 of file MueLu_SolverBase.hpp.

~SolverBase()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

virtual MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~SolverBase ( )

inlinevirtual

Definition at line 39 of file MueLu_SolverBase.hpp.

Member Function Documentation

Iterate()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

virtual void MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Iterate ( const Matrix &  A, const Constraint &  C, const Matrix &  P0, RCP< Matrix > &  P  ) const

pure virtual

Iterate

Parameters

A	– Energy matrix
C	– Constraints
P0	– Initial guess
P	– Resulting prolongator

Note

We assume that P0 has correct sparsity pattern

Implemented in MueLu::CGSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::GMRESSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

---

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

• MueLu_SolverBase.hpp