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< const ParameterList >	GetValidParameterList () const
	Input.

void	DeclareInput (Level &currentLevel) const
	Input.

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

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

Overridden from Teuchos::Describable
std::string	type_ = "Braess Sarazin"
	smoother type

RCP< const FactoryBase >	AFact_
	A Factory.

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

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

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

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

RCP< Matrix >	A00_
	matrices

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

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

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

RCP< Matrix >	S_
	Schur complement.

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

Teuchos::RCP< SmootherBase >	smoo_
	Smoother for SchurComplement 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.

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

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

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

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

BraessSarazin smoother for 2x2 block matrices.

Definition at line 43 of file MueLu_BraessSarazinSmoother_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

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

virtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 42 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ DeclareInput()

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 60 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ AddFactoryManager()

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 36 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ Setup()

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 80 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ Apply()

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 135 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ Copy()

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 301 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ description()

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 306 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ print()

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 315 of file MueLu_BraessSarazinSmoother_def.hpp.

◆ getNodeSmootherComplexity()

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

private

smoother type

Definition at line 103 of file MueLu_BraessSarazinSmoother_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<const FactoryBase> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AFact_

private

A Factory.

Definition at line 105 of file MueLu_BraessSarazinSmoother_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>

RCP<const FactoryManagerBase> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactManager_

private

Factory manager for creating the Schur Complement.

Definition at line 106 of file MueLu_BraessSarazinSmoother_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::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::A_ = Teuchos::null

private

block operator

Definition at line 109 of file MueLu_BraessSarazinSmoother_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 MapExtractor> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rangeMapExtractor_

private

range map extractor (from A_ generated by AFact)

Definition at line 111 of file MueLu_BraessSarazinSmoother_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 MapExtractor> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domainMapExtractor_

private

domain map extractor (from A_ generated by AFact)

Definition at line 112 of file MueLu_BraessSarazinSmoother_decl.hpp.

◆ A00_

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 115 of file MueLu_BraessSarazinSmoother_decl.hpp.

◆ A01_

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 116 of file MueLu_BraessSarazinSmoother_decl.hpp.

◆ A10_

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 117 of file MueLu_BraessSarazinSmoother_decl.hpp.

◆ A11_

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 118 of file MueLu_BraessSarazinSmoother_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<Matrix> MueLu::BraessSarazinSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::S_

private

Schur complement.

Definition at line 119 of file MueLu_BraessSarazinSmoother_decl.hpp.

◆ D_

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 120 of file MueLu_BraessSarazinSmoother_decl.hpp.

◆ smoo_

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 122 of file MueLu_BraessSarazinSmoother_decl.hpp.

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

Public Member Functions

Overridden from Teuchos::Describable

Setup and Apply methods.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ AddFactoryManager()

◆ Setup()

◆ Apply()

◆ Copy()

◆ description()

◆ print()

◆ getNodeSmootherComplexity()

Member Data Documentation

◆ type_

◆ AFact_

◆ FactManager_

◆ A_

◆ rangeMapExtractor_

◆ domainMapExtractor_

◆ A00_

◆ A01_

◆ A10_

◆ A11_

◆ S_

◆ D_

◆ smoo_