Class that encapsulates Operator smoothers. More...

#include <MueLu_RefMaxwellSmoother_decl.hpp>

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

Overridden from Teuchos::Describable
std::string	type_
std::string	cachedDescription_
RCP< Operator >	op_
	matrix, used in apply if solving residual equation
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.
void	SetupRefMaxwell (Level &currentLevel)

Constructors / destructors
	RefMaxwellSmoother (const std::string type, const Teuchos::ParameterList &paramList)
	Constructor.
virtual	~RefMaxwellSmoother ()=default
	Destructor.
void	SetParameterList (const Teuchos::ParameterList &paramList)
	Set parameters from a parameter list and return with default values.
void	DeclareInput (Level &currentLevel) const
	Input.

Computational methods.
void	Setup (Level &currentLevel)
	Set up the smoother.
void	Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
	Apply the preconditioner.

Utilities
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 ()
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
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::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Class that encapsulates Operator smoothers.

Definition at line 38 of file MueLu_RefMaxwellSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ RefMaxwellSmoother()

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

MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RefMaxwellSmoother	(	const std::string	type,
		const Teuchos::ParameterList &	paramList )

Constructor.

Parameters

type	smoother type
list	options for the particular smoother (e.g., fill factor or damping parameter)

Definition at line 28 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ ~RefMaxwellSmoother()

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>

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

virtualdefault

Destructor.

Member Function Documentation

◆ SetParameterList()

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

void MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetParameterList ( const Teuchos::ParameterList & paramList )

virtual

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

Reimplemented from MueLu::ParameterListAcceptorImpl.

Definition at line 37 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ DeclareInput()

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

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

virtual

Input.

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

Definition at line 42 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ Setup()

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

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

virtual

Set up the smoother.

This creates the underlying Operator smoother object, copies any parameter list options supplied to the constructor to the Operator object, and computes the preconditioner.

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

Definition at line 66 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ Apply()

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

void MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply	(	MultiVector &	X,
		const MultiVector &	B,
		bool	InitialGuessIsZero = false ) const

virtual

Apply the preconditioner.

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

Parameters

X	initial guess
B	right-hand side
InitialGuessIsZero	(optional) If false, some work can be avoided. Whether this actually saves any work depends on the underlying Operator implementation.

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

Definition at line 115 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ Copy()

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

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

virtual

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

Definition at line 125 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ description()

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

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

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 132 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ print()

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

void MueLu::RefMaxwellSmoother< 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 146 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ getNodeSmootherComplexity()

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

size_t MueLu::RefMaxwellSmoother< 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 171 of file MueLu_RefMaxwellSmoother_def.hpp.

◆ SetupRefMaxwell()

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

void MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetupRefMaxwell ( Level & currentLevel )

private

Definition at line 75 of file MueLu_RefMaxwellSmoother_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::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_

private

Definition at line 117 of file MueLu_RefMaxwellSmoother_decl.hpp.

◆ cachedDescription_

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

private

Definition at line 118 of file MueLu_RefMaxwellSmoother_decl.hpp.

◆ op_

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<Operator> MueLu::RefMaxwellSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::op_

private

matrix, used in apply if solving residual equation

Definition at line 121 of file MueLu_RefMaxwellSmoother_decl.hpp.

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

Overridden from Teuchos::Describable

Constructors / destructors

Computational methods.

Utilities

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RefMaxwellSmoother()

◆ ~RefMaxwellSmoother()

Member Function Documentation

◆ SetParameterList()

◆ DeclareInput()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getNodeSmootherComplexity()

◆ SetupRefMaxwell()

Member Data Documentation

◆ type_

◆ cachedDescription_

◆ op_