Factory for building blocked, segregated prolongation operators. More...

#include <MueLu_BlockedPFactory_decl.hpp>

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

Build methods.
std::vector< Teuchos::RCP< const FactoryManagerBase > >	FactManager_
	Input factories.

std::string	diagonalView_
	Factory parameters.

void	Build (Level &fineLevel, Level &coarseLevel) const
	Build method.

void	BuildP (Level &fineLevel, Level &coarseLevel) const
	Abstract Build method.

bool	areGidsUnique (const std::vector< GO > &X) const

Constructors/Destructors.
	BlockedPFactory ()
	Constructor. User can supply a factory for generating the tentative prolongator.

virtual	~BlockedPFactory ()
	Destructor.

RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.

Set methods.
void	SetDiagonalView (std::string const &diagView)
	Change view of diagonal.

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

Get methods.
std::string	GetDiagonalView ()
	Returns current view of diagonal.

void	DeclareInput (Level &fineLevel, Level &coarseLevel) const
	Input.

Additional Inherited Members
Public Member Functions inherited from MueLu::PFactory
	PFactory ()
	Constructor.

virtual	~PFactory ()
	Destructor.

void	setRestrictionMode (bool bRestrictionMode=false)

bool	isRestrictionModeSet ()
	returns restrictionMode flag

Public Member Functions inherited from MueLu::TwoLevelFactoryBase
	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

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

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

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::Factory
static void	EnableTimerSync ()

static void	DisableTimerSync ()

static void	EnableMultipleCheckGlobally ()

static void	DisableMultipleCheckGlobally ()

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 ()

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

Factory for building blocked, segregated prolongation operators.

Factory for building blocked, segregated prolongation operators of the form \( P=\\operatorname{diag}(P_{11},P_{22},\ldots)\), where \( P_{ii}\) are prolongation operators for the corresponding subblocks \(A_{ii}\) in the blocked operator \( A \).

Parameters

RCP<FactoryBase> AFact = Teuchos::null: factory for generating blocked operator \( A\).

The blocked operator \( A \) is needed for accessing the underlaying blocked maps (MapExtractors). Use the AddFactoryManager function to define block rows in the blocked operator. For each block row you have to define a special factory manager that handles the prolongation and restriction operator for the corresponding blocks. The SubBlockAFactory class provides a factory interface for accessing specific blocks in the blocked operator \( A \).

// define SubBlockAFactory objects for accessing the diagonal blocks in the blocked operator A
RCP<SubBlockAFactory> A11Fact = Teuchos::rcp(new SubBlockAFactory(MueLu::NoFactory::getRCP(), 0, 0));
RCP<SubBlockAFactory> A22Fact = Teuchos::rcp(new SubBlockAFactory(MueLu::NoFactory::getRCP(), 1, 1));
 
// define transfer operators for first block row
RCP<TentativePFactory> P11Fact = rcp(new TentativePFactory());
RCP<TransPFactory> R11Fact = rcp(new TransPFactory(P11Fact));
 
// define transfer operators for second block row
RCP<TentativePFactory> P22TentFact = rcp(new TentativePFactory());
RCP<PgPFactory> P22Fact = rcp(new PgPFactory(P22TentFact));
RCP<GenericRFactory> R22Fact = rcp(new GenericRFactory(P22Fact));
 
// setup facatory managers for first and second block row
RCP<FactoryManager> M11 = rcp(new FactoryManager());
M11->SetFactory("A", A11Fact);
M11->SetFactory("P", P11Fact);
M11->SetFactory("R", R11Fact);
 
RCP<FactoryManager> M22 = rcp(new FactoryManager());
M22->SetFactory("A", A22Fact);
M22->SetFactory("P", P22Fact);
M22->SetFactory("R", R22Fact);
 
// setup blocked transfer operator
// use Teuchos::null as AFactory -> standard "A" variable (in this case the blocked operator A)
RCP<BlockedPFactory> PFact = rcp(new BlockedPFactory());
PFact->SetFactory("A",Teuchos::null); // not necessary (use blocked operator A)
PFact->AddFactoryManager(M11); // add factory manager for first block row
PFact->AddFactoryManager(M22); // add factory manager for second block row
 
// define restriction operator
// Note: always use GenericRFactory here.
// The simple TransPFactory class cannot handle blocked operators, yet.
RCP<GenericRFactory> RFact = rcp(new GenericRFactory(PFact));
 
// RAP factory
RCP<RAPFactory> AcFact = rcp(new RAPFactory(PFact, RFact));

Definition at line 86 of file MueLu_BlockedPFactory_decl.hpp.

Constructor & Destructor Documentation

◆ BlockedPFactory()

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

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

inline

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

Definition at line 96 of file MueLu_BlockedPFactory_decl.hpp.

◆ ~BlockedPFactory()

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

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

inlinevirtual

Destructor.

Definition at line 100 of file MueLu_BlockedPFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > MueLu::BlockedPFactory< 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_BlockedPFactory_def.hpp.

◆ SetDiagonalView()

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

void MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetDiagonalView ( std::string const & diagView )

inline

Change view of diagonal.

Definition at line 110 of file MueLu_BlockedPFactory_decl.hpp.

◆ AddFactoryManager()

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

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

inline

Add a factory manager.

Definition at line 113 of file MueLu_BlockedPFactory_decl.hpp.

◆ GetDiagonalView()

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

std::string MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDiagonalView ( )

inline

Returns current view of diagonal.

Definition at line 121 of file MueLu_BlockedPFactory_decl.hpp.

◆ DeclareInput()

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

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

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 44 of file MueLu_BlockedPFactory_def.hpp.

◆ Build()

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

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

virtual

Build method.

Build segregated blocked prolongator by assembly from prolongators of each subblock in A and return it in coarseLevel .

Implements MueLu::TwoLevelFactoryBase.

Definition at line 69 of file MueLu_BlockedPFactory_def.hpp.

◆ BuildP()

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

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

virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 66 of file MueLu_BlockedPFactory_def.hpp.

◆ areGidsUnique()

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

bool MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::areGidsUnique ( const std::vector< GO > & X ) const

inlineprivate

Definition at line 147 of file MueLu_BlockedPFactory_decl.hpp.

Member Data Documentation

◆ FactManager_

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

std::vector<Teuchos::RCP<const FactoryManagerBase> > MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactManager_

private

Input factories.

Definition at line 153 of file MueLu_BlockedPFactory_decl.hpp.

◆ diagonalView_

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

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

private

Factory parameters.

Definition at line 156 of file MueLu_BlockedPFactory_decl.hpp.

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

Build methods.

Constructors/Destructors.

Set methods.

Get methods.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlockedPFactory()

◆ ~BlockedPFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ SetDiagonalView()

◆ AddFactoryManager()

◆ GetDiagonalView()

◆ DeclareInput()

◆ Build()

◆ BuildP()

◆ areGidsUnique()

Member Data Documentation

◆ FactManager_

◆ diagonalView_