MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Class that encapsulates Amesos2 direct solvers. More...

#include <MueLu_Amesos2Smoother_decl.hpp>

Inheritance diagram for MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::Factory MueLu::BaseClass MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::VerboseObject MueLu::Describable MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Overridden from Teuchos::Describable

typedef Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, NodeTpetra_CrsMatrix
 
typedef Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, NodeTpetra_MultiVector
 
std::string type_
 amesos2-specific key phrase that denote smoother type
 
RCP< Amesos2::Solver< Tpetra_CrsMatrix, Tpetra_MultiVector > > prec_
 pointer to Amesos2 solver object
 
bool useTransformation_
 
RCP< MultiVector > X_
 
RCP< MultiVector > B_
 
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

 Amesos2Smoother (const std::string &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList())
 Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type=="", then either SuperLU or KLU2 are used by default.
 
virtual ~Amesos2Smoother ()
 Destructor.
 
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept.
 
void DeclareInput (Level &currentLevel) const
 Input.
 

Setup and Apply methods.

void Setup (Level &currentLevel)
 Set up the direct solver. This creates the underlying Amesos2 solver object according to the parameter list options passed into the Amesos2Smoother constructor. This includes doing a numeric factorization of the matrix.
 
void Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
 Apply the direct solver. Solves the linear system AX=B using the constructed solver.
 
RCP< SmootherPrototypeCopy () 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 FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory()
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) const
 
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
 
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 >
Get (Level &level, const std::string &varName) const
 
template<class 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
 
bool IsAvailable (Level &level, const std::string &varName) const
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Class that encapsulates Amesos2 direct solvers.

This class creates an Amesos2 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 77 of file MueLu_Amesos2Smoother_decl.hpp.

Member Typedef Documentation

◆ Tpetra_CrsMatrix

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Tpetra::CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Tpetra_CrsMatrix
private

Definition at line 142 of file MueLu_Amesos2Smoother_decl.hpp.

◆ Tpetra_MultiVector

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
typedef Tpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Tpetra_MultiVector
private

Definition at line 143 of file MueLu_Amesos2Smoother_decl.hpp.

Constructor & Destructor Documentation

◆ Amesos2Smoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Amesos2Smoother ( const std::string & type = "",
const Teuchos::ParameterList & paramList = Teuchos::ParameterList() )

Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type=="", then either SuperLU or KLU2 are used by default.

Definition at line 66 of file MueLu_Amesos2Smoother_def.hpp.

◆ ~Amesos2Smoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~Amesos2Smoother ( )
virtual

Destructor.

Definition at line 109 of file MueLu_Amesos2Smoother_def.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Reimplemented from MueLu::Factory.

Definition at line 112 of file MueLu_Amesos2Smoother_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel) const
virtual

◆ Setup()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level & currentLevel)
virtual

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

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

Definition at line 133 of file MueLu_Amesos2Smoother_def.hpp.

◆ Apply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, 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
Xinitial guess
Bright-hand side
InitialGuessIsZeroThis option has no effect.

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

Definition at line 256 of file MueLu_Amesos2Smoother_def.hpp.

◆ Copy()

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 311 of file MueLu_Amesos2Smoother_def.hpp.

◆ print()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::print ( Teuchos::FancyOStream & out,
const VerbLevel verbLevel = Default ) const

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

Definition at line 325 of file MueLu_Amesos2Smoother_def.hpp.

◆ getNodeSmootherComplexity()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const
virtual

Get a rough estimate of cost per iteration.

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

Definition at line 349 of file MueLu_Amesos2Smoother_def.hpp.

Member Data Documentation

◆ type_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
std::string MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_
private

amesos2-specific key phrase that denote smoother type

Definition at line 146 of file MueLu_Amesos2Smoother_decl.hpp.

◆ prec_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<Amesos2::Solver<Tpetra_CrsMatrix, Tpetra_MultiVector> > MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::prec_
private

pointer to Amesos2 solver object

Definition at line 149 of file MueLu_Amesos2Smoother_decl.hpp.

◆ useTransformation_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
bool MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::useTransformation_
private

Definition at line 151 of file MueLu_Amesos2Smoother_decl.hpp.

◆ X_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<MultiVector> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::X_
private

Definition at line 152 of file MueLu_Amesos2Smoother_decl.hpp.

◆ B_

template<class Scalar = SmootherPrototype<>::scalar_type, class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
RCP<MultiVector> MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::B_
private

Definition at line 152 of file MueLu_Amesos2Smoother_decl.hpp.


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