Prolongator factory that replicates 'Psubblock' matrix to create new prolongator suitable for PDE systems. More...

#include <MueLu_CombinePFactory_decl.hpp>

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

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

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

virtual	~PFactory ()
	Destructor. More...

void	setRestrictionMode (bool bRestrictionMode=false)

bool	isRestrictionModeSet ()
	returns restrictionMode flag More...

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

virtual	~TwoLevelFactoryBase ()
	Destructor. More...

virtual void	CallDeclareInput (Level &requestedLevel) const

virtual void	CallBuild (Level &requestedLevel) const

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

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

	Factory ()
	Constructor. More...

virtual	~Factory ()
	Destructor. More...

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

const RCP< const FactoryBase >	GetFactory (const std::string &varName) const
	Default implementation of FactoryAcceptor::GetFactory() More...

RCP< ParameterList >	RemoveFactoriesFromList (const ParameterList &list) 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::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

virtual std::string	description () const
	Return a simple one-line description of this object. More...

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::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. 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
int	numPDEs_

Friends
class	MueLuTests::CombinePFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Constructors/Destructors.
	CombinePFactory ()
	Constructor. More...

virtual	~CombinePFactory ()
	Destructor. More...

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

Build methods.
void	Build (Level &fineLevel, Level &coarseLevel) const
	Build an object with this factory. More...

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

Additional Inherited Members
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	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 Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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

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

Prolongator factory that replicates 'Psubblock' matrix to create new prolongator suitable for PDE systems.

Takes a set of previously generated prolongators each for a subsystem multiphysics PDE and effectively makes a block diagonal prolongator by combining the "combo: npdes" times so that it can be used with a PDE system. A normal use case would be to run an existing MueLu multigrid algorithm on a set of scalar PDEs to generate a hierarchy. Then use something like

MueLu::HierarchyUtils<SC,LO,GO,NO>::CopyBetweenHierarchies(*scalarHierarchy0,*systemHierarchy, "P", "Psubblock0", "RCP<Matrix>"); . . . . . . MueLu::HierarchyUtils<SC,LO,GO,NO>::CopyBetweenHierarchies(*scalarHierarchy7,*systemHierarchy, "P", "Psubblock6", "RCP<Matrix>");

to copy them to a new hierarchy. This new hierarchy would then have <Parameter name="multigrid algorithm" type="string" value="combo"> in its parameter list to then invoke ComboPFactory. Currently, this is used in src/Operators/MueLu_Multiphysics_def.hpp with an example in test/multiphysics.

The end result is a block diagonal matrix corresponding to [Psubblock0 ] [ Psubblock1 ] [ Psubblock2 ] P = [ Psubblock3 ] [ Psubblock4 ] [ Psubblock5 ] [ Psubblock6]

Input/output of CombinePFactory

User parameters of SemiCoarsenPFactory

Parameter	type	default	master.xml	validated	description
combo: npdes	int	1	*	*	Specifies the number of Psubblock# matrices to expect
Psubblock0	Matrix				Matrix defining P(0,0) block
Psubblock1	Matrix				Matrix defining P(1,1) block
.	.				.
.	.				.
.	.				.
Psubblockk	Matrix				Matrix defining P(k,k) block

The * in the master.xml column denotes that the parameter is defined in the master.xml file.
The * in the validated column means that the parameter is declared in the list of valid input parameters (see CombineCoarsenPFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see CombineCoarsenPFactory::DeclareInput).

Variables provided by CombinePFactory

After CombinePFactory::Build the following data is available (if requested)

Parameter	generated by	description
P	CombinePFactory	Prolongator

Definition at line 94 of file MueLu_CombinePFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

inline

Constructor.

Definition at line 105 of file MueLu_CombinePFactory_decl.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 108 of file MueLu_CombinePFactory_decl.hpp.

Member Function Documentation

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

RCP< const ParameterList > MueLu::CombinePFactory< 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 39 of file MueLu_CombinePFactory_def.hpp.

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

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

virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 49 of file MueLu_CombinePFactory_def.hpp.

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

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 54 of file MueLu_CombinePFactory_def.hpp.

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

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

virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 60 of file MueLu_CombinePFactory_def.hpp.

Friends And Related Function Documentation

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

friend class MueLuTests::CombinePFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >

friend

Definition at line 99 of file MueLu_CombinePFactory_decl.hpp.

Member Data Documentation

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

int MueLu::CombinePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numPDEs_

private

Definition at line 129 of file MueLu_CombinePFactory_decl.hpp.

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

Public Member Functions

Private Attributes

Friends

Constructors/Destructors.

Build methods.

Additional Inherited Members

Detailed Description

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

Input/output of CombinePFactory

User parameters of SemiCoarsenPFactory

Variables provided by CombinePFactory

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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