block Jacobi method for blocked matrices More...

#include <MueLu_BlockedJacobiSmoother_decl.hpp>

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

Private Types
typedef Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >	MapExtractorClass

Overridden from Teuchos::Describable
std::string	type_
	smoother type

std::vector< Teuchos::RCP< const FactoryManagerBase > >	FactManager_
	vector of factory managers

std::vector< Teuchos::RCP< const SmootherBase > >	Inverse_
	vector of smoother/solver factories

std::vector< bool >	bIsBlockedOperator_
	vector storing whether sub-block is a blocked operator (needed for nested blocked smoothers using Thyra GIDs)

RCP< FactoryBase >	AFact_
	A Factory.

RCP< Matrix >	A_
	internal blocked operator "A" generated by AFact_

RCP< const MapExtractorClass >	rangeMapExtractor_
	domain map extractor (from A_ generated by AFact)

RCP< const MapExtractorClass >	domainMapExtractor_

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
	BlockedJacobiSmoother ()
	Constructor.

virtual	~BlockedJacobiSmoother ()
	Destructor.

RCP< const ParameterList >	GetValidParameterList () const
	Input.

void	DeclareInput (Level &currentLevel) const
	Input.

void	AddFactoryManager (RCP< const FactoryManagerBase > FactManager, int pos)
	Add a factory manager.

Setup and Apply methods.
void	Setup (Level &currentLevel)
	Setup routine In the Setup method the Inverse_ vector is filled with the corresponding SmootherBase objects. Without the Inverse_ vector being filled we cannot call BlockedJacobiSmoother::Apply.

void	Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
	Apply the direct 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

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

block Jacobi method for blocked matrices

Implementation of a block Jacobi methods for blocked matrices

Parameters

LocalOrdinal	sweeps = 1: number of sweeps
Scalar	omega = 1.0: damping parameter
RCP<FactoryBase>	AFact = Teuchos::null: factory for blocked "A" operator

Use the AddFactoryManager routine to declare the subsmoothers/subsolvers for the block Jacobi method for the block rows. The corresponding factory manager has to provide a variable "A" (pointing to the subblock of the blocked A operator) and a smoother object (variable: "PreSmoother").

Example

// prototypes for direct solvers for blocks 1 and 2
RCP<SmootherPrototype> smoProto11 = rcp( new DirectSolver("", Teuchos::ParameterList(), A11Fact) );
RCP<SmootherPrototype> smoProto22 = rcp( new DirectSolver("", Teuchos::ParameterList(), A22Fact) );
RCP<SmootherFactory> Smoo11Fact = rcp( new SmootherFactory(smoProto11) );
RCP<SmootherFactory> Smoo22Fact = rcp( new SmootherFactory(smoProto22) );
 
// define factory manager objects for sublocks
RCP<FactoryManager> M11 = rcp(new FactoryManager());
M11->SetFactory("A", A11Fact);
M11->SetFactory("Smoother", Smoo11Fact);
 
RCP<FactoryManager> M22 = rcp(new FactoryManager());
M22->SetFactory("A", A22Fact);
M22->SetFactory("Smoother", Smoo22Fact);
 
// create blocked Jacobi smoother for 2x2 blocked matrix
RCP<BlockedJacobiSmoother> smootherPrototype = rcp(new BlockedJacobiSmoother(2,1.0));
smootherPrototype->AddFactoryManager(M11);
smootherPrototype->AddFactoryManager(M22);
RCP<SmootherFactory> smootherFact = rcp( new SmootherFactory(smootherPrototype) );
 
// use smootherFact in main-factory manager

Author: mayr.mt

Date: 06/2017

Definition at line 79 of file MueLu_BlockedJacobiSmoother_decl.hpp.

Member Typedef Documentation

◆ MapExtractorClass

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 Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractorClass

private

Definition at line 80 of file MueLu_BlockedJacobiSmoother_decl.hpp.

Constructor & Destructor Documentation

◆ BlockedJacobiSmoother()

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

MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedJacobiSmoother ( )

Constructor.

Definition at line 34 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ ~BlockedJacobiSmoother()

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

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

virtual

Destructor.

Definition at line 41 of file MueLu_BlockedJacobiSmoother_def.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const

virtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 44 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ DeclareInput()

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

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

virtual

Input.

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

Definition at line 76 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ AddFactoryManager()

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

void MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager	(	RCP< const FactoryManagerBase >	FactManager,
		int	pos
	)

Add a factory manager.

Add a factory manager at a specific position

Definition at line 55 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ Setup()

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

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

virtual

Setup routine In the Setup method the Inverse_ vector is filled with the corresponding SmootherBase objects. Without the Inverse_ vector being filled we cannot call BlockedJacobiSmoother::Apply.

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

Definition at line 95 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ Apply()

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

void MueLu::BlockedJacobiSmoother< 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 132 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ Copy()

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

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

virtual

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

Definition at line 275 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ description()

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

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

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 280 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ print()

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

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

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

Using MueLu::Describable::describe; // overloading, not hiding

Definition at line 288 of file MueLu_BlockedJacobiSmoother_def.hpp.

◆ getNodeSmootherComplexity()

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

size_t MueLu::BlockedJacobiSmoother< 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 306 of file MueLu_BlockedJacobiSmoother_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::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_

private

smoother type

Definition at line 152 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ FactManager_

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::vector<Teuchos::RCP<const FactoryManagerBase> > MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactManager_

private

vector of factory managers

Definition at line 155 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ Inverse_

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::vector<Teuchos::RCP<const SmootherBase> > MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Inverse_

private

vector of smoother/solver factories

Definition at line 158 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ bIsBlockedOperator_

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::vector<bool> MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bIsBlockedOperator_

private

vector storing whether sub-block is a blocked operator (needed for nested blocked smoothers using Thyra GIDs)

Definition at line 161 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ AFact_

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

private

A Factory.

Definition at line 164 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ A_

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

private

internal blocked operator "A" generated by AFact_

range map extractor (from A_ generated by AFact)

Definition at line 167 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ rangeMapExtractor_

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<const MapExtractorClass> MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rangeMapExtractor_

private

domain map extractor (from A_ generated by AFact)

Definition at line 170 of file MueLu_BlockedJacobiSmoother_decl.hpp.

◆ domainMapExtractor_

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<const MapExtractorClass> MueLu::BlockedJacobiSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domainMapExtractor_

private

Definition at line 173 of file MueLu_BlockedJacobiSmoother_decl.hpp.

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

Private Types

Overridden from Teuchos::Describable

Constructors / destructors

Setup and Apply methods.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MapExtractorClass

Constructor & Destructor Documentation

◆ BlockedJacobiSmoother()

◆ ~BlockedJacobiSmoother()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ AddFactoryManager()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getNodeSmootherComplexity()

Member Data Documentation

◆ type_

◆ FactManager_

◆ Inverse_

◆ bIsBlockedOperator_

◆ AFact_

◆ A_

◆ rangeMapExtractor_

◆ domainMapExtractor_