MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Functions
MueLuAdapters

The main MueLu adapters (interfaces) More...

Classes

class  MueLu::Maxwell1< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form. More...
 
class  MueLu::Maxwell_Utils< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 Utility functions for Maxwell. More...
 
class  MueLu::MultiPhys< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 Preconditioner (wrapped as a Xpetra::Operator) for solving MultiPhysics PDEs. More...
 
class  MueLu::RefMaxwell< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 Preconditioner (wrapped as a Xpetra::Operator) for Maxwell's equations in curl-curl form. More...
 
class  MueLu::ShiftedLaplacian< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 Shifted Laplacian Helmholtz solver. More...
 
class  MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 Adapter for AmgX library from Nvidia. More...
 

Functions

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< MueLu::Hierarchy
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		MueLu::CreateXpetraPreconditioner (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >> op, const Teuchos::ParameterList &inParamList)
 Helper function to create a MueLu preconditioner that can be used by Xpetra.Given an Xpetra::Matrix, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< MueLu::Hierarchy
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		MueLu::CreateXpetraPreconditioner (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >> op, const std::string &xmlFileName)
 Helper function to create a MueLu preconditioner that can be used by Xpetra.Given an Xpetra::Matrix, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< MueLu::Hierarchy
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		MueLu::CreateXpetraPreconditioner (Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >> op)
 Helper function to create a MueLu preconditioner that can be used by Xpetra.Given an Xpetra::Matrix, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReuseXpetraPreconditioner (const Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >> &A, Teuchos::RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node >> &H)
 Helper function to reuse an existing MueLu preconditioner. More...
 
Teuchos::RCP
< MueLu::EpetraOperator > 		MueLu::CreateEpetraPreconditioner (const Teuchos::RCP< Epetra_CrsMatrix > &inA, Teuchos::ParameterList &paramListIn)
 Helper function to create a MueLu preconditioner that can be used by Epetra.Given a EpetraCrs_Matrix, this function returns a constructed MueLu preconditioner. More...
 
Teuchos::RCP
< MueLu::EpetraOperator > 		MueLu::CreateEpetraPreconditioner (const Teuchos::RCP< Epetra_CrsMatrix > &A, const std::string &xmlFileName)
 Helper function to create a MueLu preconditioner that can be used by Epetra.Given a Epetra_CrsMatrix, this function returns a constructed MueLu preconditioner. More...
 
Teuchos::RCP
< MueLu::EpetraOperator > 		MueLu::CreateEpetraPreconditioner (const Teuchos::RCP< Epetra_CrsMatrix > &A)
 Helper function to create a MueLu preconditioner that can be used by Epetra.Given a Epetra_CrsMatrix, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP
< MueLu::TpetraOperator
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		MueLu::CreateTpetraPreconditioner (const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &inA, Teuchos::ParameterList &inParamList)
 Helper function to create a MueLu or AMGX preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP
< MueLu::TpetraOperator
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		MueLu::CreateTpetraPreconditioner (const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &inA, const std::string &xmlFileName)
 Helper function to create a MueLu preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP
< MueLu::TpetraOperator
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		MueLu::CreateTpetraPreconditioner (const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &inA)
 Helper function to create a MueLu preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReuseTpetraPreconditioner (const Teuchos::RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &inA, MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Op)
 Helper function to reuse an existing MueLu preconditioner. More...
 

Detailed Description

The main MueLu adapters (interfaces)

Most applications will use these interfaces to create preconditioners with MueLu. Options are passed to the adapters via Teuchos::ParameterLists or XML input files. Applications can optionally provide nullspace vectors (if known) and/or mesh coordinate vectors (for parallel rebalancing and auxiliary dropping). Adapters are available for Epetra and Tpetra, and return Epetra_Operators and Tpetra::Operators, respectively.

Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::CreateXpetraPreconditioner ( Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >>  op,
const Teuchos::ParameterList &  inParamList 
)

Helper function to create a MueLu preconditioner that can be used by Xpetra.Given an Xpetra::Matrix, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix
[in]inParamListParameter list

Definition at line 43 of file MueLu_CreateXpetraPreconditioner.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::CreateXpetraPreconditioner ( Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >>  op,
const std::string &  xmlFileName 
)

Helper function to create a MueLu preconditioner that can be used by Xpetra.Given an Xpetra::Matrix, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix
[in]xmlFileNamestd::string

Definition at line 127 of file MueLu_CreateXpetraPreconditioner.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::CreateXpetraPreconditioner ( Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >>  op)

Helper function to create a MueLu preconditioner that can be used by Xpetra.Given an Xpetra::Matrix, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix

Definition at line 143 of file MueLu_CreateXpetraPreconditioner.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReuseXpetraPreconditioner ( const Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >> &  A,
Teuchos::RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node >> &  H 
)

Helper function to reuse an existing MueLu preconditioner.

Parameters
[in]inAMatrix
[in]OpExisting MueLu preconditioner.

Definition at line 156 of file MueLu_CreateXpetraPreconditioner.hpp.

Teuchos::RCP< MueLu::EpetraOperator > MueLu::CreateEpetraPreconditioner ( const Teuchos::RCP< Epetra_CrsMatrix > &  inA,
Teuchos::ParameterList &  paramListIn 
)

Helper function to create a MueLu preconditioner that can be used by Epetra.Given a EpetraCrs_Matrix, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix
[in]paramListInParameter list

Definition at line 42 of file MueLu_CreateEpetraPreconditioner.cpp.

Teuchos::RCP< MueLu::EpetraOperator > MueLu::CreateEpetraPreconditioner ( const Teuchos::RCP< Epetra_CrsMatrix > &  A,
const std::string &  xmlFileName 
)

Helper function to create a MueLu preconditioner that can be used by Epetra.Given a Epetra_CrsMatrix, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix
[in]xmlFileNameXML file containing MueLu options.
[in]inAMatrix

Definition at line 94 of file MueLu_CreateEpetraPreconditioner.cpp.

Teuchos::RCP<MueLu::EpetraOperator> MueLu::CreateEpetraPreconditioner ( const Teuchos::RCP< Epetra_CrsMatrix > &  A)

Helper function to create a MueLu preconditioner that can be used by Epetra.Given a Epetra_CrsMatrix, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix.

Definition at line 109 of file MueLu_CreateEpetraPreconditioner.cpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP<MueLu::TpetraOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::CreateTpetraPreconditioner ( const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  inA,
Teuchos::ParameterList &  inParamList 
)

Helper function to create a MueLu or AMGX preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix
[in]inParamListParameter list

Definition at line 53 of file MueLu_CreateTpetraPreconditioner.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP<MueLu::TpetraOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::CreateTpetraPreconditioner ( const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  inA,
const std::string &  xmlFileName 
)

Helper function to create a MueLu preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix
[in]xmlFileNameXML file containing MueLu options

Definition at line 127 of file MueLu_CreateTpetraPreconditioner.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP<MueLu::TpetraOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::CreateTpetraPreconditioner ( const Teuchos::RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  inA)

Helper function to create a MueLu preconditioner that can be used by Tpetra.Given a Tpetra::Operator, this function returns a constructed MueLu preconditioner.

Parameters
[in]inAMatrix

Definition at line 144 of file MueLu_CreateTpetraPreconditioner.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReuseTpetraPreconditioner ( const Teuchos::RCP< Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  inA,
MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  Op 
)

Helper function to reuse an existing MueLu preconditioner.

Parameters
[in]inAMatrix
[in]OpExisting MueLu preconditioner.

Definition at line 157 of file MueLu_CreateTpetraPreconditioner.hpp.