Factory for building Petrov-Galerkin Smoothed Aggregation prolongators. More...

#include <MueLu_PgPFactory_decl.hpp>

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

Build methods.
std::string	diagonalView_
	Factory parameters.
void	Build (Level &fineLevel, Level &coarseLevel) const
	Build method.
void	BuildP (Level &fineLevel, Level &coarseLevel) const
	Abstract Build method.
void	ReUseDampingParameters (bool bReuse)
void	MultiplySelfAll (const RCP< Matrix > &Op, Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &InnerProdVec) const
void	MultiplyAll (const RCP< Matrix > &left, const RCP< Matrix > &right, Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &InnerProdVec) const
void	ComputeRowBasedOmega (Level &fineLevel, Level &coarseLevel, const RCP< Matrix > &A, const RCP< Matrix > &P0, const RCP< Matrix > &DinvAP0, RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &RowBasedOmega) const

Constructors/Destructors.
	PgPFactory ()
	Constructor. User can supply a factory for generating the tentative prolongator.
virtual	~PgPFactory ()
	Destructor.

Set methods.
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.
void	SetMinimizationMode (MinimizationNorm minnorm)
	Set minimization mode (L2NORM for cheapest, ANORM more expensive, DINVANORM = default).
MinimizationNorm	GetMinimizationMode ()
	return minimization mode
void	DeclareInput (Level &fineLevel, Level &coarseLevel) const
	Input.

Additional Inherited Members
	PFactory ()
	Constructor.
virtual	~PFactory ()
	Destructor.
void	setRestrictionMode (bool bRestrictionMode=false)
bool	isRestrictionModeSet ()
	returns restrictionMode flag
	TwoLevelFactoryBase ()
	Constructor.
virtual	~TwoLevelFactoryBase ()
	Destructor.
virtual void	CallDeclareInput (Level &requestedLevel) const
virtual void	CallBuild (Level &requestedLevel) const
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
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
virtual std::string	description () const
	Return a simple one-line description of this object.
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::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
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 Public Member Functions inherited from MueLu::Factory
static void	EnableTimerSync ()
static void	DisableTimerSync ()
static void	EnableMultipleCheckGlobally ()
static void	DisableMultipleCheckGlobally ()
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 ()
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
Protected Attributes inherited from MueLu::PFactory
bool	restrictionMode_
Static Protected Attributes inherited from MueLu::Factory
static bool	timerSync_ = false

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building Petrov-Galerkin Smoothed Aggregation prolongators.

Definition at line 46 of file MueLu_PgPFactory_decl.hpp.

Constructor & Destructor Documentation

◆ PgPFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inline

Constructor. User can supply a factory for generating the tentative prolongator.

Definition at line 57 of file MueLu_PgPFactory_decl.hpp.

◆ ~PgPFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inlinevirtual

Destructor.

Definition at line 60 of file MueLu_PgPFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

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

virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Reimplemented from MueLu::Factory.

Definition at line 34 of file MueLu_PgPFactory_def.hpp.

◆ SetMinimizationMode()

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

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetMinimizationMode ( MinimizationNorm minnorm )

Set minimization mode (L2NORM for cheapest, ANORM more expensive, DINVANORM = default).

Definition at line 46 of file MueLu_PgPFactory_def.hpp.

◆ GetMinimizationMode()

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

MueLu::MinimizationNorm MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetMinimizationMode ( )

return minimization mode

Definition at line 51 of file MueLu_PgPFactory_def.hpp.

◆ DeclareInput()

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

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput	(	Level &	fineLevel,
		Level &	coarseLevel ) const

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 57 of file MueLu_PgPFactory_def.hpp.

◆ Build()

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

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build	(	Level &	fineLevel,
		Level &	coarseLevel ) const

virtual

Build method.

Builds smoothed aggregation prolongator and returns it in coarseLevel.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 91 of file MueLu_PgPFactory_def.hpp.

◆ BuildP()

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

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildP	(	Level &	fineLevel,
		Level &	coarseLevel ) const

virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 643 of file MueLu_PgPFactory_def.hpp.

◆ ReUseDampingParameters()

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

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReUseDampingParameters ( bool bReuse )

Definition at line 648 of file MueLu_PgPFactory_def.hpp.

◆ MultiplySelfAll()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MultiplySelfAll	(	const RCP< Matrix > &	Op,
		Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	InnerProdVec ) const

private

Definition at line 393 of file MueLu_PgPFactory_def.hpp.

◆ MultiplyAll()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MultiplyAll	(	const RCP< Matrix > &	left,
		const RCP< Matrix > &	right,
		Teuchos::RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	InnerProdVec ) const

private

Definition at line 430 of file MueLu_PgPFactory_def.hpp.

◆ ComputeRowBasedOmega()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

void MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ComputeRowBasedOmega	(	Level &	fineLevel,
		Level &	coarseLevel,
		const RCP< Matrix > &	A,
		const RCP< Matrix > &	P0,
		const RCP< Matrix > &	DinvAP0,
		RCP< Xpetra::Vector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	RowBasedOmega ) const

private

Teuchos::ScalarTraits<Scalar>::one()

Definition at line 212 of file MueLu_PgPFactory_def.hpp.

Member Data Documentation

◆ diagonalView_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

std::string MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::diagonalView_

private

Factory parameters.

Definition at line 107 of file MueLu_PgPFactory_decl.hpp.

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

Build methods.

Constructors/Destructors.

Set methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PgPFactory()

◆ ~PgPFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ SetMinimizationMode()

◆ GetMinimizationMode()

◆ DeclareInput()

◆ Build()

◆ BuildP()

◆ ReUseDampingParameters()

◆ MultiplySelfAll()

◆ MultiplyAll()

◆ ComputeRowBasedOmega()

Member Data Documentation

◆ diagonalView_