Factory for generating F/C-splitting and a coarse level map. Used by ClassicalPFactory. More...

#include <MueLu_ClassicalMapFactory_decl.hpp>

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

Public Types
enum	point_type { F_PT = -1, UNASSIGNED = 0, C_PT = 1, DIRICHLET_PT = 2 }
	F/C/Dirichlet point type. More...

Protected Member Functions
virtual void	GenerateCoarseMap (const Map &fineMap, LO num_c_points, Teuchos::RCP< const Map > &coarseMap) const

virtual void	DoGraphColoring (const LWGraph &graph, Teuchos::ArrayRCP< LO > &myColors, LO &numColors) const

virtual void	DoMISNaive (const LWGraph &graph, Teuchos::ArrayRCP< LO > &myColors, LO &numColors) const

virtual void	DoDistributedGraphColoring (RCP< const LWGraph > &graph, Teuchos::ArrayRCP< LO > &myColors, LO &numColors) 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

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

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

Build methods.
void	Build (Level &currentLevel) const override
	Build an object with this factory. More...

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

virtual	~SingleLevelFactoryBase ()
	Destructor. More...

virtual void	CallBuild (Level &requestedLevel) const

virtual void	CallDeclareInput (Level &requestedLevel) const

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

void	DisableMultipleCallCheck () const

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

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

virtual const RCP< const FactoryBase >	GetFactory (const std::string &varName) const =0

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

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

Detailed Description

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

Factory for generating F/C-splitting and a coarse level map. Used by ClassicalPFactory.

Input/output

User parameters of this factory

Parameter	type	default	master.xml	validated	requested	description
Graph	Factory	null		*	*	Generating factory for graph.

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 Build() the following data is available (if requested)

Parameter	generated by	description
Colors	ClassicalMapFactory	ArrayRCP<LO> of colors
CoarseMap	CoarseMapFactory	Map containing the coarse map used as domain map in the classical prolongator

Definition at line 99 of file MueLu_ClassicalMapFactory_decl.hpp.

Member Enumeration Documentation

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

enum MueLu::ClassicalMapFactory::point_type

F/C/Dirichlet point type.

Enumerator
F_PT
UNASSIGNED
C_PT
DIRICHLET_PT

Definition at line 105 of file MueLu_ClassicalMapFactory_decl.hpp.

Member Function Documentation

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

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

overridevirtual

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.

Implements MueLu::ParameterListAcceptor.

Definition at line 86 of file MueLu_ClassicalMapFactory_def.hpp.

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

void MueLu::ClassicalMapFactory< 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 103 of file MueLu_ClassicalMapFactory_def.hpp.

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

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

overridevirtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 115 of file MueLu_ClassicalMapFactory_def.hpp.

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

void MueLu::ClassicalMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GenerateCoarseMap	(	const Map &	fineMap,
		LO	num_c_points,
		Teuchos::RCP< const Map > &	coarseMap
	)		const

protectedvirtual

Definition at line 291 of file MueLu_ClassicalMapFactory_def.hpp.

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

void MueLu::ClassicalMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DoGraphColoring	(	const LWGraph &	graph,
		Teuchos::ArrayRCP< LO > &	myColors,
		LO &	numColors
	)		const

protectedvirtual

Definition at line 309 of file MueLu_ClassicalMapFactory_def.hpp.

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

void MueLu::ClassicalMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DoMISNaive	(	const LWGraph &	graph,
		Teuchos::ArrayRCP< LO > &	myColors,
		LO &	numColors
	)		const

protectedvirtual

Definition at line 401 of file MueLu_ClassicalMapFactory_def.hpp.

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

void MueLu::ClassicalMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DoDistributedGraphColoring	(	RCP< const LWGraph > &	graph,
		Teuchos::ArrayRCP< LO > &	myColors,
		LO &	numColors
	)		const

protectedvirtual

Definition at line 433 of file MueLu_ClassicalMapFactory_def.hpp.

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

Public Types

Protected Member Functions

Input

Build methods.

Additional Inherited Members

Detailed Description

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

Input/output

User parameters of this factory

Variables provided by this factory

Member Enumeration Documentation

Member Function Documentation

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