BraessSarazin smoother for 2x2 block matrices. More...

#include <MueLu_BraessSarazinSmoother_decl.hpp>

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

Public Member Functions
RCP< SmootherPrototype >	Copy () const

Public Member Functions inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >
	SmootherPrototype ()
	/Destructors. More...

virtual	~SmootherPrototype ()

bool	IsSetup () const
	Get the state of a smoother prototype. More...

void	IsSetup (bool const &ToF)
	Set the state of a smoother prototype. More...

virtual void	CallBuild (Level &) const

virtual void	CallDeclareInput (Level &requestedLevel) const

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. More...

Public Member Functions inherited from MueLu::VerboseObject
VerbLevel	GetVerbLevel () const
	Get the verbosity level. More...

void	SetVerbLevel (const VerbLevel verbLevel)
	Set the verbosity level of this object. More...

int	GetProcRankVerbose () const
	Get proc rank used for printing. Do not use this information for any other purpose. More...

int	SetProcRankVerbose (int procRank) const
	Set proc rank used for printing. More...

bool	IsPrint (MsgType type, int thisProcRankOnly=-1) const
	Find out whether we need to print out information for a specific message type. More...

Teuchos::FancyOStream &	GetOStream (MsgType type, int thisProcRankOnly=0) const
	Get an output stream for outputting the input message type. More...

Teuchos::FancyOStream &	GetBlackHole () const

	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

Public Member Functions inherited from MueLu::Describable
virtual	~Describable ()
	Destructor. More...

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

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. More...

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Public Member Functions inherited from MueLu::Factory
void	EnableMultipleCallCheck () const
	Constructor. More...

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

Public Member Functions inherited from MueLu::FactoryBase
	FactoryBase ()
	Constructor. More...

virtual	~FactoryBase ()
	Destructor. More...

int	GetID () const
	return unique factory id More...

Public Member Functions inherited from MueLu::FactoryAcceptor
virtual	~FactoryAcceptor ()

virtual void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
	Configuration. More...

virtual const RCP< const FactoryBase >	GetFactory (const std::string &varName) const =0

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. More...

virtual const Teuchos::ParameterList &	GetParameterList () const

void	SetParameter (const std::string &name, const ParameterEntry &entry)
	Set a parameter directly as a ParameterEntry. More...

const ParameterEntry &	GetParameter (const std::string &name) const
	Retrieves a const entry with the name name. More...

virtual void	GetDocumentation (std::ostream &os) const

Public Member Functions inherited from MueLu::ParameterListAcceptor
	ParameterListAcceptor ()

virtual	~ParameterListAcceptor ()=default

Private Attributes
std::string	type_ = "Braess Sarazin"
	smoother type More...

RCP< const FactoryBase >	AFact_
	A Factory. More...

RCP< const FactoryManagerBase >	FactManager_
	Factory manager for creating the Schur Complement. More...

RCP< Matrix >	A_ = Teuchos::null
	block operator More...

RCP< const MapExtractor >	rangeMapExtractor_
	range map extractor (from A_ generated by AFact) More...

RCP< const MapExtractor >	domainMapExtractor_
	domain map extractor (from A_ generated by AFact) More...

RCP< Matrix >	A00_
	matrices More...

RCP< Matrix >	A01_
	Block (0,1) [typically, pressure gradient operator]. More...

RCP< Matrix >	A10_
	Block (1,0) [typically, divergence operator]. More...

RCP< Matrix >	A11_
	Block (1,1) [typically, pressure stabilization term or null block]. More...

RCP< Matrix >	S_
	Schur complement. More...

RCP< Vector >	D_
	Inverse to approximation to block (0,0). Here, D_ = omega*inv(diag(A(0,0))) More...

Teuchos::RCP< SmootherBase >	smoo_
	Smoother for SchurComplement equation. More...

RCP< const ParameterList >	GetValidParameterList () const
	Input. More...

void	DeclareInput (Level &currentLevel) const
	Input. More...

void	AddFactoryManager (RCP< const FactoryManagerBase > FactManager, int pos=0)
	Add a factory manager for BraessSarazin internal SchurComplement handling. More...

Setup and Apply methods.
void	Setup (Level &currentLevel)
	Setup routine. More...

void	Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
	Apply the Braess Sarazin smoother. More...

Overridden from Teuchos::Describable
std::string	description () const
	Return a simple one-line description of this object. More...

void	print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
	Print the object with some verbosity level to an FancyOStream object. More...

size_t	getNodeSmootherComplexity () const
	Get a rough estimate of cost per iteration. More...

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

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

static Teuchos::RCP < Teuchos::FancyOStream >	GetMueLuOStream ()

static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Member Functions inherited from MueLu::Factory
static void	EnableMultipleCheckGlobally ()

static void	DisableMultipleCheckGlobally ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

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

BraessSarazin smoother for 2x2 block matrices.

Definition at line 80 of file MueLu_BraessSarazinSmoother_decl.hpp.

Member Function Documentation

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

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

virtual

Input.

Implements MueLu::ParameterListAcceptor.

Definition at line 79 of file MueLu_BraessSarazinSmoother_def.hpp.

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

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

virtual

Input.

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

Definition at line 97 of file MueLu_BraessSarazinSmoother_def.hpp.

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

void MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager	(	RCP< const FactoryManagerBase >	FactManager,
		int	pos = `0`
	)

Add a factory manager for BraessSarazin internal SchurComplement handling.

Definition at line 73 of file MueLu_BraessSarazinSmoother_def.hpp.

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

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

virtual

Setup routine.

Setup routine can be summarized in 4 steps:

set the map extractors
set the blocks
create and set the inverse of the diagonal of F
set the smoother for the Schur Complement

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

Definition at line 117 of file MueLu_BraessSarazinSmoother_def.hpp.

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

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

virtual

Apply the Braess Sarazin smoother.

Parameters

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

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

Definition at line 172 of file MueLu_BraessSarazinSmoother_def.hpp.

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

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

virtual

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

Definition at line 338 of file MueLu_BraessSarazinSmoother_def.hpp.

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

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

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 344 of file MueLu_BraessSarazinSmoother_def.hpp.

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

void MueLu::BraessSarazinSmoother< 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 352 of file MueLu_BraessSarazinSmoother_def.hpp.

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

size_t MueLu::BraessSarazinSmoother< 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 365 of file MueLu_BraessSarazinSmoother_def.hpp.

Member Data Documentation

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::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::type_ = "Braess Sarazin"

private

smoother type

Definition at line 140 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

private

A Factory.

Definition at line 142 of file MueLu_BraessSarazinSmoother_decl.hpp.

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 FactoryManagerBase> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactManager_

private

Factory manager for creating the Schur Complement.

Definition at line 143 of file MueLu_BraessSarazinSmoother_decl.hpp.

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::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::A_ = Teuchos::null

private

block operator

Definition at line 146 of file MueLu_BraessSarazinSmoother_decl.hpp.

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 MapExtractor> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rangeMapExtractor_

private

range map extractor (from A_ generated by AFact)

Definition at line 148 of file MueLu_BraessSarazinSmoother_decl.hpp.

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 MapExtractor> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domainMapExtractor_

private

domain map extractor (from A_ generated by AFact)

Definition at line 149 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

private

matrices

Block (0,0) [typically, fluid operator]

Definition at line 152 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

private

Block (0,1) [typically, pressure gradient operator].

Definition at line 153 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

private

Block (1,0) [typically, divergence operator].

Definition at line 154 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

private

Block (1,1) [typically, pressure stabilization term or null block].

Definition at line 155 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

private

Schur complement.

Definition at line 156 of file MueLu_BraessSarazinSmoother_decl.hpp.

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<Vector> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::D_

private

Inverse to approximation to block (0,0). Here, D_ = omega*inv(diag(A(0,0)))

Definition at line 157 of file MueLu_BraessSarazinSmoother_decl.hpp.

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<SmootherBase> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::smoo_

private

Smoother for SchurComplement equation.

Definition at line 159 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

Public Member Functions

Private Attributes

Setup and Apply methods.

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation