Factory for building a new "segregated" A operator. Here, "segregated" means that the user provides some map(s) (containing a subset of GIDs of the input matrix A) and the factory drops entries depending on the dropping scheme. More...

#include <MueLu_SegregatedAFactory_decl.hpp>

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

Public Member Functions
RCP< const ParameterList >	GetValidParameterList () const override
	Input.

void	DeclareInput (Level &currentLevel) const override
	Specifies the data that this class needs, and the factories that generate that data.

Public Member Functions inherited from MueLu::SingleLevelFactoryBase
	SingleLevelFactoryBase ()
	Constructor.

virtual	~SingleLevelFactoryBase ()
	Destructor.

virtual void	CallBuild (Level &requestedLevel) const

virtual void	CallDeclareInput (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

Build methods.
void	Build (Level &currentLevel) const override
	Build method.

void	BuildBasedOnBlockmap (Level &currentLevel) const

void	BuildBasedOnMapPair (Level &currentLevel) const

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

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

Factory for building a new "segregated" A operator. Here, "segregated" means that the user provides some map(s) (containing a subset of GIDs of the input matrix A) and the factory drops entries depending on the dropping scheme.

Idea

The idea is to use the output matrix A as input for the aggregation factory to have control over the aggregates and make sure that aggregates do not cross certain areas.

Remarks

This factory supports multiple dropping schemes based on different inputs. They are:

blockmap: Based on the user provided "blockmap", the off-diagonal entries (a,b) and (b,a) in A are dropped. "a" denotes a GID entry in the provided map and "b" denotes a GID that is not contained in the provided map. In this use case the Factory expects a dropMap1 (==blockmap). The blockmap scheme also doesn't support the "Call ReduceAll on dropMap1/2" options.
map-pair: Based on a "map-pair", the user provides two maps "dropMap1" and "dropMap2", which specify global row/column pairs in the operator A to be dropped. The Factory drops any possible combination of the dropMaps 1 and 2. To ensure that entry A(a,b) is dropped, as well as entry A(b,a), there is an option to create redundant dropMaps on all Procs. This ensures that entries aren't overlooked due to the local rowmaps of the operator A.

Note: we have to drop the entries (i.e. not just set them to zero) as the CoalesceDropFactory does not distinguish between matrix entries which are zero and nonzero.

Input/output of this factory

User parameters of SegregatedAFactory

Parameter	type	default	validated	requested	description
A	Factory	null	*	*	Generating factory of the matrix A
droppingScheme	string	vague	*	*	Strategy to drop entries from matrix A based on the input of some map(s) [blockmap, map-pair]
dropMap1	Factory	null	*	*	Generating factory for dropMap1
dropMap2	Factory	null	*	*	Generating factory for dropMap2

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 GetValidParameters() ).
The * in the requested column states that the data is requested as input with all dependencies (see DeclareInput() ).

Variables provided by this factory

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

Parameter	generated by	description
A	SegregatedAFactory	Provides a filtered Matrix, where all possible combinations of the entries of the dropMap(s) have been removed from the input matrix A

Definition at line 75 of file MueLu_SegregatedAFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

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

overridevirtual

Input.

Reimplemented from MueLu::Factory.

Definition at line 25 of file MueLu_SegregatedAFactory_def.hpp.

◆ DeclareInput()

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

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

overridevirtual

Specifies the data that this class needs, and the factories that generate that data.

If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 38 of file MueLu_SegregatedAFactory_def.hpp.