MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode > Class Reference

#include <MueLu_Ifpack2Smoother_decl.hpp>

Inheritance diagram for MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >:
MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode > MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode > MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode > MueLu::Factory MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode > MueLu::Factory MueLu::ParameterListAcceptorImpl MueLu::FactoryAcceptor MueLu::FactoryBase MueLu::BaseClass MueLu::ParameterListAcceptorImpl MueLu::FactoryAcceptor MueLu::FactoryBase MueLu::BaseClass

Public Member Functions

 Ifpack2Smoother (const std::string &type, const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), const LocalOrdinal &overlap=0)
virtual ~Ifpack2Smoother ()
void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values.
void DeclareInput (Level &currentLevel) const
 Input.
void Setup (Level &currentLevel)
void Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
 Apply smoother.
RCP< SmootherPrototype > Copy () const
std::string description () const
 Return a simple one-line description of this object.
void print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
size_t getNodeSmootherComplexity () const
 Get a rough estimate of cost per iteration.
Public Member Functions inherited from MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >
 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.
Public Member Functions inherited from MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >
 SmootherBase ()
virtual ~SmootherBase ()
void declareConstructionOutcome (bool fail, std::string msg)
bool constructionSuccessful ()
std::string constructionErrorMsg ()
virtual ~BaseClass ()
 Destructor.
 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 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
 ParameterListAcceptor ()
virtual ~ParameterListAcceptor ()=default

Private Types

typedef double Scalar
typedef int LocalOrdinal
typedef int GlobalOrdinal
typedef Xpetra::EpetraNode Node

Private Member Functions

void SetPrecParameters (const Teuchos::ParameterList &list=Teuchos::ParameterList()) const

Friends

template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
class Ifpack2Smoother

Overridden from Teuchos::Describable

RCP< Ifpack2::Preconditioner< double, int, int, Xpetra::EpetraNode > > getPreconditioner ()
 For diagnostic purposes.
void SetupSchwarz (Level &currentLevel)
void SetupChebyshev (Level &currentLevel)
void SetupLineSmoothing (Level &currentLevel)
void SetupBlockRelaxation (Level &currentLevel)
void SetupTopological (Level &currentLevel)
void SetupAggregate (Level &currentLevel)
void SetupHiptmair (Level &currentLevel)
void SetupGeneric (Level &currentLevel)
double SetupChebyshevEigenvalues (Level &currentLevel, const std::string &matrixName, const std::string &label, Teuchos::ParameterList &paramList) const
bool constructionSuccessful_
std::string type_
 ifpack2-specific key phrase that denote smoother type
LO overlap_
 overlap when using the smoother in additive Schwarz mode
RCP< Ifpack2::Preconditioner< double, int, int, Xpetra::EpetraNode > > prec_
 pointer to Ifpack2 preconditioner object
RCP< Operator > A_
 matrix, used in apply if solving residual equation

Additional Inherited Members

Public Types inherited from MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >
typedef double scalar_type
typedef int local_ordinal_type
typedef int global_ordinal_type
typedef Xpetra::EpetraNode node_type
Public Types inherited from MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >
typedef double scalar_type
typedef int local_ordinal_type
typedef int global_ordinal_type
typedef Xpetra::EpetraNode node_type
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

Definition at line 207 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Typedef Documentation

◆ Scalar

typedef double MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Scalar
private

Definition at line 208 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ LocalOrdinal

typedef int MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::LocalOrdinal
private

Definition at line 209 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ GlobalOrdinal

typedef int MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::GlobalOrdinal
private

Definition at line 210 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ Node

typedef Xpetra::EpetraNode MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Node
private

Definition at line 211 of file MueLu_Ifpack2Smoother_decl.hpp.

Constructor & Destructor Documentation

◆ Ifpack2Smoother()

MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Ifpack2Smoother ( const std::string & type,
const Teuchos::ParameterList & paramList = Teuchos::ParameterList(),
const LocalOrdinal & overlap = 0 )
inline

Definition at line 222 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ ~Ifpack2Smoother()

virtual MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::~Ifpack2Smoother ( )
inlinevirtual

Definition at line 226 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Function Documentation

◆ SetParameterList()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetParameterList ( const Teuchos::ParameterList & paramList)
inlinevirtual

Set parameters from a parameter list and return with default values.

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 228 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ DeclareInput()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::DeclareInput ( Level & currentLevel) const
inlinevirtual

Input.

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 229 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ Setup()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Setup ( Level & currentLevel)
inlinevirtual

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 230 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ Apply()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Apply ( MultiVector & x,
const MultiVector & rhs,
bool InitialGuessIsZero = false ) const
inlinevirtual

Apply smoother.

Implements MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >.

Definition at line 231 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ Copy()

RCP< SmootherPrototype > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::Copy ( ) const
inlinevirtual

Implements MueLu::SmootherPrototype< double, int, int, Xpetra::EpetraNode >.

Definition at line 232 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ description()

std::string MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 234 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ print()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::print ( Teuchos::FancyOStream & out,
const VerbLevel verbLevel = Default ) const
inline

Definition at line 235 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ getNodeSmootherComplexity()

size_t MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::getNodeSmootherComplexity ( ) const
inlinevirtual

Get a rough estimate of cost per iteration.

Implements MueLu::SmootherBase< double, int, int, Xpetra::EpetraNode >.

Definition at line 238 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ SetPrecParameters()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetPrecParameters ( const Teuchos::ParameterList & list = Teuchos::ParameterList()) const
inlineprivate

Definition at line 244 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ getPreconditioner()

RCP< Ifpack2::Preconditioner< double, int, int, Xpetra::EpetraNode > > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::getPreconditioner ( )
inline

For diagnostic purposes.

Definition at line 165 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ SetupSchwarz()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupSchwarz ( Level & currentLevel)
private

Definition at line 173 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupChebyshev()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupChebyshev ( Level & currentLevel)
private

Definition at line 174 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupLineSmoothing()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupLineSmoothing ( Level & currentLevel)
private

Definition at line 175 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupBlockRelaxation()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupBlockRelaxation ( Level & currentLevel)
private

Definition at line 176 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupTopological()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupTopological ( Level & currentLevel)
private

◆ SetupAggregate()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupAggregate ( Level & currentLevel)
private

Definition at line 178 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupHiptmair()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupHiptmair ( Level & currentLevel)
private

Definition at line 179 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupGeneric()

void MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupGeneric ( Level & currentLevel)
private

Definition at line 180 of file MueLu_Ifpack2Smoother_def.hpp.

◆ SetupChebyshevEigenvalues()

double MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::SetupChebyshevEigenvalues ( Level & currentLevel,
const std::string & matrixName,
const std::string & label,
Teuchos::ParameterList & paramList ) const
private

Definition at line 181 of file MueLu_Ifpack2Smoother_def.hpp.

◆ Ifpack2Smoother

template<class Scalar2, class LocalOrdinal2, class GlobalOrdinal2, class Node2>
friend class Ifpack2Smoother
friend

Definition at line 219 of file MueLu_Ifpack2Smoother_decl.hpp.

Member Data Documentation

◆ constructionSuccessful_

bool MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::constructionSuccessful_
private

Definition at line 185 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ type_

std::string MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::type_
private

ifpack2-specific key phrase that denote smoother type

Definition at line 188 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ overlap_

LO MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::overlap_
private

overlap when using the smoother in additive Schwarz mode

Definition at line 191 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ prec_

RCP<Ifpack2::Preconditioner<double, int, int, Xpetra::EpetraNode> > MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::prec_
private

pointer to Ifpack2 preconditioner object

Definition at line 194 of file MueLu_Ifpack2Smoother_decl.hpp.

◆ A_

RCP<Operator> MueLu::Ifpack2Smoother< double, int, int, Xpetra::EpetraNode >::A_
private

matrix, used in apply if solving residual equation

Definition at line 197 of file MueLu_Ifpack2Smoother_decl.hpp.

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