This class first calculates row- and column permutation operators and applies a smoother to the permuted linear system. More...

#include <MueLu_PermutingSmoother_decl.hpp>

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

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

LO	overlap_
	overlap when using the smoother in additive Schwarz mode

RCP< FactoryBase >	permFact_
	Permutation Factory.

RCP< Matrix >	permQT_
	permQT matrix object

RCP< Matrix >	permP_
	permP matrix object

Teuchos::RCP< Matrix >	diagScalingOp_
	scaling matrix object

RCP< SmootherPrototype >	s_
	Smoother.

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
	PermutingSmoother (std::string const &mapName, const RCP< const FactoryBase > &mapFact, std::string const &type="", const Teuchos::ParameterList &paramList=Teuchos::ParameterList(), LO const &overlap=0, RCP< FactoryBase > permFact=Teuchos::null)
	Constructor.

virtual	~PermutingSmoother ()
	Destructor.

void	DeclareInput (Level &currentLevel) const
	Input.

Setup and Apply methods.
void	Setup (Level &currentLevel)
	Set up the direct solver.

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< 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 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::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

This class first calculates row- and column permutation operators and applies a smoother to the permuted linear system.

Definition at line 47 of file MueLu_PermutingSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ PermutingSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::PermutingSmoother	(	std::string const &	mapName,
		const RCP< const FactoryBase > &	mapFact,
		std::string const &	type = `""`,
		const Teuchos::ParameterList &	paramList = `Teuchos::ParameterList()`,
		LO const &	overlap = `0`,
		RCP< FactoryBase >	permFact = `Teuchos::null`
	)

Constructor.

Parameters

[in]	mapName	Name of map object in level class, which rows/cols can be permuted
[in]	mapFact	generating factory of map with name mapName
[in]	type	string that contains type of smoother (e.g. "RELAXATION" or "ILU")
[in]	paramList	parameter list with parameters for smoother (default: empty)
[in]	overlap	LocalOrdinal with overlap inforation (default: 0)
[in]	permFact	factory, generating permutation and scaling matrices (default: Teuchos::null -> use internal PermutationFactory instance)

Definition at line 38 of file MueLu_PermutingSmoother_def.hpp.

◆ ~PermutingSmoother()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Destructor.

Definition at line 71 of file MueLu_PermutingSmoother_def.hpp.

Member Function Documentation

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & currentLevel ) const

virtual

Input.

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

Definition at line 74 of file MueLu_PermutingSmoother_def.hpp.

◆ Setup()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Setup ( Level & currentLevel )

virtual

Set up the direct solver.

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

Definition at line 83 of file MueLu_PermutingSmoother_def.hpp.

◆ Apply()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::PermutingSmoother< 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

X	initial guess
B	right-hand side
InitialGuessIsZero	This option has no effect.

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

Definition at line 100 of file MueLu_PermutingSmoother_def.hpp.

◆ Copy()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Copy ( ) const

virtual

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

Definition at line 123 of file MueLu_PermutingSmoother_def.hpp.

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

std::string MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 128 of file MueLu_PermutingSmoother_def.hpp.

◆ print()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::PermutingSmoother< 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 135 of file MueLu_PermutingSmoother_def.hpp.

◆ getNodeSmootherComplexity()

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>

size_t MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNodeSmootherComplexity ( ) const

inlinevirtual

Get a rough estimate of cost per iteration.

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

Definition at line 103 of file MueLu_PermutingSmoother_decl.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::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_

private

ifpack1/2-specific key phrase that denote smoother type

Definition at line 109 of file MueLu_PermutingSmoother_decl.hpp.

◆ overlap_

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>

LO MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::overlap_

private

overlap when using the smoother in additive Schwarz mode

Definition at line 112 of file MueLu_PermutingSmoother_decl.hpp.

◆ permFact_

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<FactoryBase> MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::permFact_

private

Permutation Factory.

Definition at line 115 of file MueLu_PermutingSmoother_decl.hpp.

◆ permQT_

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<Matrix> MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::permQT_

private

permQT matrix object

Definition at line 118 of file MueLu_PermutingSmoother_decl.hpp.

◆ permP_

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<Matrix> MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::permP_

private

permP matrix object

Definition at line 121 of file MueLu_PermutingSmoother_decl.hpp.

◆ diagScalingOp_

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>

Teuchos::RCP<Matrix> MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::diagScalingOp_

private

scaling matrix object

Definition at line 124 of file MueLu_PermutingSmoother_decl.hpp.

◆ s_

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<SmootherPrototype> MueLu::PermutingSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::s_

private

Smoother.

Definition at line 131 of file MueLu_PermutingSmoother_decl.hpp.

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

Overridden from Teuchos::Describable

Constructors / destructors

Setup and Apply methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PermutingSmoother()

◆ ~PermutingSmoother()

Member Function Documentation

◆ DeclareInput()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getNodeSmootherComplexity()

Member Data Documentation

◆ type_

◆ overlap_

◆ permFact_

◆ permQT_

◆ permP_

◆ diagScalingOp_

◆ s_