Class for transferring a vector of local ordinals from a finer level to a coarser one, where each aggregate has a unique one. More...

#include <MueLu_LocalOrdinalTransferFactory_decl.hpp>

Inheritance diagram for MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >:

Private Member Functions
void	BuildAggregates (Level &fineLevel, Level &coarseLevel) const

void	BuildFC (Level &fineLevel, Level &coarseLevel) const

Private Attributes
bool	useAggregatesMode_
	Use aggregates mode (as opposed to FC mode) More...

std::string	TransferVecName_
	The name for the vector to be transfered. This allows us to have multiple factories for different variables. More...

Constructors/Destructors.
	LocalOrdinalTransferFactory ()=delete

	LocalOrdinalTransferFactory (const std::string &TransferVecName, const std::string &mode)
	Constructor. More...

virtual	~LocalOrdinalTransferFactory ()
	Destructor. More...

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

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

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

Additional Inherited Members
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

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

Static Protected Attributes inherited from MueLu::Factory
static bool	timerSync_ = false

Detailed Description

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >

Class for transferring a vector of local ordinals from a finer level to a coarser one, where each aggregate has a unique one.

Input/output of LocalOrdinalTransferFactory

User parameters of LocalOrdinalTransferFactory

Parameter	type	default	validated	requested	description
TransferVec	Factory	null	*	(*)	Factory providing vector to be transered
Aggregates	Factory	null	*	(*)	Factory providing aggregates
CoarseMap	Factory	null	*	(*)	Generating factory of the coarse map
write start	int	-1	*		first level at which coordinates should be written to file
write end	int	-1	*		last level at which coordinates should be written to file

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

The LocalOrdinalTransferFact first checks whether there is already valid coarse TransferVec information available on the coarse level. If that is the case, we can skip the coarse TransferVec generation and just reuse the available information. Otherwise we try to build coarse grid TransverVec by using the information about the aggregates, the fine level TransferVec and the coarse map information.

Variables provided by LocalOrdinalTransferFactory

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

Parameter	generated by	description
TransferVec	LocalOrdinalTransferFactory	coarse level transfervec

Definition at line 60 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.

Constructor & Destructor Documentation

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

MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::LocalOrdinalTransferFactory ( )

delete

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

MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::LocalOrdinalTransferFactory	(	const std::string &	TransferVecName,
		const std::string &	mode
	)

inline

Constructor.

Parameters

vectorName	The name of the quantity to be restricted.
restrictionName	The name of the restriction Matrix.

The operator associated with projectionName will be applied to the MultiVector associated with vectorName.

Definition at line 79 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 88 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< const ParameterList > MueLu::LocalOrdinalTransferFactory< 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 29 of file MueLu_LocalOrdinalTransferFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::DeclareInput	(	Level &	finelevel,
		Level &	coarseLevel
	)		const

virtual

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::TwoLevelFactoryBase.

Definition at line 41 of file MueLu_LocalOrdinalTransferFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 59 of file MueLu_LocalOrdinalTransferFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregates	(	Level &	fineLevel,
		Level &	coarseLevel
	)		const

private

Definition at line 149 of file MueLu_LocalOrdinalTransferFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::BuildFC	(	Level &	fineLevel,
		Level &	coarseLevel
	)		const

private

Definition at line 67 of file MueLu_LocalOrdinalTransferFactory_def.hpp.

Member Data Documentation

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

bool MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::useAggregatesMode_

private

Use aggregates mode (as opposed to FC mode)

Definition at line 120 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.

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

std::string MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >::TransferVecName_

private

The name for the vector to be transfered. This allows us to have multiple factories for different variables.

Definition at line 123 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.

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

Private Member Functions

Private Attributes

Constructors/Destructors.

Input

Build methods.

Additional Inherited Members

Detailed Description

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode> class MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >

Input/output of LocalOrdinalTransferFactory

User parameters of LocalOrdinalTransferFactory

Variables provided by LocalOrdinalTransferFactory

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::LocalOrdinalTransferFactory< LocalOrdinal, GlobalOrdinal, Node >