Class that encapsulates Amesos direct solvers. More...

#include <MueLu_AmesosSmoother.hpp>

Inheritance diagram for MueLu::AmesosSmoother< Node >:

Private Types
typedef double	Scalar

typedef int	LocalOrdinal

typedef int	GlobalOrdinal

Overridden from Teuchos::Describable
std::string	type_
	amesos-specific key phrase that denote smoother type

RCP< Matrix >	A_
	Matrix. Not used directly, but held inside of linearProblem_. So we have to keep an RCP pointer to it!

RCP< Epetra_LinearProblem >	linearProblem_
	Problem that Amesos uses internally.

RCP< Amesos_BaseSolver >	prec_
	pointer to Amesos solver object

std::string	description () const
	Return a simple one-line description of this object.

void	print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
	Print the object with some verbosity level to an FancyOStream object.

size_t	getNodeSmootherComplexity () const
	Get a rough estimate of cost per iteration.

Constructors / destructors
	AmesosSmoother (const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
	Constructor.

virtual	~AmesosSmoother ()
	Destructor.

void	DeclareInput (Level &currentLevel) const
	Input.

Setup and Apply methods.
void	Setup (Level &currentLevel)
	Set up the direct solver. This creates the underlying Amesos solver object according to the parameter list options passed into the AmesosSmoother constructor. This includes doing a numeric factorization of the matrix.

void	Apply (MultiVector &X, const MultiVector &B, bool=false) const
	Apply the direct solver.

RCP< SmootherPrototype >	Copy () const

Additional Inherited Members
Public Types inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

Public Types inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
typedef Scalar	scalar_type

typedef LocalOrdinal	local_ordinal_type

typedef GlobalOrdinal	global_ordinal_type

typedef Node	node_type

Public Member Functions inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
	SmootherPrototype ()
	@nameConstructors/Destructors.

virtual	~SmootherPrototype ()

virtual void	CallBuild (Level &) const

virtual void	CallDeclareInput (Level &requestedLevel) const

bool	IsSetup () const
	Get the state of a smoother prototype.

void	IsSetup (bool const &ToF)
	Set the state of a smoother prototype.

Public Member Functions inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
	SmootherBase ()

virtual	~SmootherBase ()

void	declareConstructionOutcome (bool fail, std::string msg)

bool	constructionSuccessful ()

std::string	constructionErrorMsg ()

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

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.

Public Member Functions inherited from MueLu::Factory
	Factory ()
	Constructor.

virtual	~Factory ()
	Destructor.

virtual void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
	Configuration.

const RCP< const FactoryBase >	GetFactory (const std::string &varName) const
	Default implementation of FactoryAcceptor::GetFactory()

RCP< ParameterList >	RemoveFactoriesFromList (const ParameterList &list) const

virtual RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.

void	EnableMultipleCallCheck () const

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

Public Member Functions inherited from MueLu::FactoryBase
	FactoryBase ()
	Constructor.

virtual	~FactoryBase ()
	Destructor.

int	GetID () const
	return unique factory id

Public Member Functions inherited from MueLu::FactoryAcceptor
virtual	~FactoryAcceptor ()

Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
	ParameterListAcceptorImpl ()

virtual	~ParameterListAcceptorImpl ()=default

virtual void	SetParameterList (const Teuchos::ParameterList &paramList)
	Set parameters from a parameter list and return with default values.

virtual const Teuchos::ParameterList &	GetParameterList () const

virtual const Teuchos::ParameterList &	GetParameterListWithoutValidation () const

void	SetParameter (const std::string &name, const ParameterEntry &entry)
	Set a parameter directly as a ParameterEntry.

const ParameterEntry &	GetParameter (const std::string &name) const
	Retrieves a const entry with the name name.

virtual void	GetDocumentation (std::ostream &os) const

Public Member Functions inherited from MueLu::ParameterListAcceptor
	ParameterListAcceptor ()

virtual	~ParameterListAcceptor ()=default

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 ()

Static Public Member Functions inherited from MueLu::Factory
static void	EnableTimerSync ()

static void	DisableTimerSync ()

static void	EnableMultipleCheckGlobally ()

static void	DisableMultipleCheckGlobally ()

Protected Member Functions inherited from MueLu::Factory
void	Input (Level &level, const std::string &varName) const

void	Input (Level &level, const std::string &varName, const std::string &varParamName) const

template<class T >
T	Get (Level &level, const std::string &varName) const

template<class T >
T	Get (Level &level, const std::string &varName, const std::string &varParamName) const

template<class T >
void	Set (Level &level, const std::string &varName, const T &data) const

template<class T >
bool	IsType (Level &level, const std::string &varName) const

bool	IsAvailable (Level &level, const std::string &varName) const

Static Protected Attributes inherited from MueLu::Factory
static bool	timerSync_ = false

Detailed Description

template<class Node = typename SmootherPrototype<double, int, int>::node_type>
class MueLu::AmesosSmoother< Node >

Class that encapsulates Amesos direct solvers.

This class creates an Amesos preconditioner factory. The factory is capable of generating direct solvers based on the type and ParameterList passed into the constructor. See the constructor for more information.

Definition at line 40 of file MueLu_AmesosSmoother.hpp.

Member Typedef Documentation

◆ Scalar

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

typedef double MueLu::AmesosSmoother< Node >::Scalar

private

Definition at line 41 of file MueLu_AmesosSmoother.hpp.

◆ LocalOrdinal

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

typedef int MueLu::AmesosSmoother< Node >::LocalOrdinal

private

Definition at line 42 of file MueLu_AmesosSmoother.hpp.

◆ GlobalOrdinal

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

typedef int MueLu::AmesosSmoother< Node >::GlobalOrdinal

private

Definition at line 43 of file MueLu_AmesosSmoother.hpp.

Constructor & Destructor Documentation

◆ AmesosSmoother()

template<class Node >

MueLu::AmesosSmoother< Node >::AmesosSmoother	(	const std::string &	type = `""`,
		const Teuchos::ParameterList &	paramList = `Teuchos::ParameterList()`
	)

Constructor.

Creates a MueLu interface to the direct solvers in the Amesos package. The options are those specified in the Amesos user's manual.

Parameters

type	solver type
list	options for the particular solver type

Here is how to select the more commonly used direct solvers:

KLU (serial sparse direct solver)
- type = Amesos-KLU
- parameter list options
  - none required
SuperLU (serial sparse super-nodal direct solver)
- type = Amesos-SuperLU
- parameter list options
  - none required

If you are using type=="", then either SuperLU or KLU are used by default.

◆ ~AmesosSmoother()

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

virtual MueLu::AmesosSmoother< Node >::~AmesosSmoother ( )

inlinevirtual

Destructor.

Definition at line 81 of file MueLu_AmesosSmoother.hpp.

Member Function Documentation

◆ DeclareInput()

template<class Node >

void MueLu::AmesosSmoother< Node >::DeclareInput ( Level & currentLevel ) const

virtual

Input.

Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 74 of file MueLu_AmesosSmoother.cpp.

◆ Setup()

template<class Node >

void MueLu::AmesosSmoother< Node >::Setup ( Level & currentLevel )

virtual

Set up the direct solver. This creates the underlying Amesos solver object according to the parameter list options passed into the AmesosSmoother constructor. This includes doing a numeric factorization of the matrix.

Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 79 of file MueLu_AmesosSmoother.cpp.

◆ Apply()

template<class Node >

void MueLu::AmesosSmoother< Node >::Apply	(	MultiVector &	X,
		const MultiVector &	B,
		bool	InitialGuessIsZero = `false`
	)		const

virtual

Apply the direct solver.

Solves the linear system AX=B using the constructed solver.

Parameters

X	initial guess
B	right-hand side
InitialGuessIsZero	This option has no effect with this smoother

Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 114 of file MueLu_AmesosSmoother.cpp.

◆ Copy()

template<class Node >

RCP< MueLu::SmootherPrototype< double, int, int, Node > > MueLu::AmesosSmoother< Node >::Copy ( ) const

virtual

Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 134 of file MueLu_AmesosSmoother.cpp.

◆ description()

template<class Node >

std::string MueLu::AmesosSmoother< Node >::description ( ) const

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 139 of file MueLu_AmesosSmoother.cpp.

◆ print()

template<class Node >

void MueLu::AmesosSmoother< Node >::print	(	Teuchos::FancyOStream &	out,
		const VerbLevel	verbLevel = `Default`
	)		const

Print the object with some verbosity level to an FancyOStream object.

Definition at line 148 of file MueLu_AmesosSmoother.cpp.

◆ getNodeSmootherComplexity()

template<class Node >

size_t MueLu::AmesosSmoother< Node >::getNodeSmootherComplexity ( ) const

virtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 176 of file MueLu_AmesosSmoother.cpp.

Member Data Documentation

◆ type_

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

std::string MueLu::AmesosSmoother< Node >::type_

private

amesos-specific key phrase that denote smoother type

Definition at line 140 of file MueLu_AmesosSmoother.hpp.

◆ A_

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

RCP<Matrix> MueLu::AmesosSmoother< Node >::A_

private

Matrix. Not used directly, but held inside of linearProblem_. So we have to keep an RCP pointer to it!

Definition at line 143 of file MueLu_AmesosSmoother.hpp.

◆ linearProblem_

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

RCP<Epetra_LinearProblem> MueLu::AmesosSmoother< Node >::linearProblem_

private

Problem that Amesos uses internally.

Definition at line 146 of file MueLu_AmesosSmoother.hpp.

◆ prec_

template<class Node = typename SmootherPrototype<double, int, int>::node_type>

RCP<Amesos_BaseSolver> MueLu::AmesosSmoother< Node >::prec_

private

pointer to Amesos solver object

Definition at line 149 of file MueLu_AmesosSmoother.hpp.

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

Private Types

Overridden from Teuchos::Describable

Constructors / destructors

Setup and Apply methods.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Scalar

◆ LocalOrdinal

◆ GlobalOrdinal

Constructor & Destructor Documentation

◆ AmesosSmoother()

◆ ~AmesosSmoother()

Member Function Documentation

◆ DeclareInput()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getNodeSmootherComplexity()

Member Data Documentation

◆ type_

◆ A_

◆ linearProblem_

◆ prec_