Factory for generating coarse level map. Used by TentativePFactory. More...

#include <MueLu_CoarseMapFactory_decl.hpp>

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

Public Member Functions
	CoarseMapFactory ()

	~CoarseMapFactory ()

virtual size_t	getFixedBlockSize () const
	Get information on the fixed block size. More...

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

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

Protected Member Functions
virtual void	BuildCoarseMap (Level &currentLevel, const GlobalOrdinal domainGIDOffset) const
	Build the coarse map using the domain GID offset. More...

virtual GlobalOrdinal	GetDomainGIDOffset (Level &currentLevel) const
	Extract domain GID offset from user data. More...

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

Private Member Functions
virtual void	CheckForConsistentStridingInformation (LocalOrdinal stridedBlockId, const size_t nullspaceDimension) const

Private Attributes
std::vector< size_t >	stridingInfo_
	Vector with size of strided blocks (dofs) More...

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

Get/Set functions
virtual std::vector< size_t >	getStridingData () const
	getStridingData returns vector with size of striding blocks in the domain DOF map (= coarse map). e.g. for 2 velocity dofs and 1 pressure dof the vector is (2,1) More...

virtual void	setStridingData (std::vector< size_t > stridingInfo)
	setStridingData set striding vector for the domain DOF map (= coarse map), e.g. (2,1) for 2 velocity dofs and 1 pressure dof More...

virtual LocalOrdinal	getStridedBlockId () const
	getStridedBlockId returns strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map) More...

virtual void	setStridedBlockId (LocalOrdinal stridedBlockId)
	setStridedBlockId set strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map) 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

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

Factory for generating coarse level map. Used by TentativePFactory.

Factory is used by TentativePFactory to generate the coarse level map (=domain map) of the prolongation operator. The number of DOFs is calculated by the following formula

\[ n_{Aggs}\cdot d_{blocksize} \]

where \( n_{Aggs} \) denotes the number of aggregates (generated by the AggregationFactory) and \( d_{blocksize}\) denotes the number of DOFs per node on the coarse level. For determing the blocksize, the CoarseMapFactory supports strided map information. Per default stridedBlockId is -1 and the number of nullspace vectors (from "Nullspace" ) is used. Otherwise, the block size is calculated using the striding information.

By setting the "Domain GID offsets" parameter, we can specify the GID offset manually for each level. If the number of entries in that list is smaller than the number of levels, we use the default offset 0 for the remaining coarse levels.

Input/output

User parameters of this factory

Parameter	type	default	validated	requested	description
Aggregates	Factory	null	*	*	Generating factory for aggregates. We basically need only the number of aggregates in this factory.
Nullspace	Factory	null	*	*	Generating factory of the fine nullspace vectors (of type "MultiVector"). In the default case the same instance of the TentativePFactory is also the generating factory for the null space vectors (on the next coarser levels). Therefore, it is recommended to declare the TentativePFactory to be the generating factory of the "Nullspace" variable globally using the FactoryManager object! For defining the near null space vectors on the finest level one should use the NullspaceFactory.
Striding info	std::string	{}	*		String containing the striding information, e.g. {2,1} for a fixed block size of 3 with sub blocks of size 2 and 1 in each node.
Strided block id	LocalOrdinal	-1	*		Strided block id in strided information vector or -1 (=default) for the full block information.
Domain GID offsets	std::string	{0}	*		String describing a std::vector with offsets for GIDs for each level. If no offset GID value is given for the level we use 0 as default.

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

Note: To auto-compute the Domain GID offset on each level, consider to use the BlockedCoarseMapFactory .

Variables provided by this factory

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

Parameter	generated by	description
CoarseMap	CoarseMapFactory	Map containing the coarse map used as domain map in the tentative prolongation operator

Definition at line 77 of file MueLu_CoarseMapFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

default

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

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

default

Member Function Documentation

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

RCP< const ParameterList > MueLu::CoarseMapFactory< 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.

Reimplemented from MueLu::Factory.

Definition at line 39 of file MueLu_CoarseMapFactory_def.hpp.

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

void MueLu::CoarseMapFactory< 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 62 of file MueLu_CoarseMapFactory_def.hpp.

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

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

overridevirtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 80 of file MueLu_CoarseMapFactory_def.hpp.

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

virtual size_t MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getFixedBlockSize ( ) const

inlinevirtual

Get information on the fixed block size.

Returns the full block size (number of DOFs per node) of the domain DOF map (= coarse map). This is the sum of all entries in the striding vector. e.g. for 2 velocity dofs and 1 pressure dof the return value is 3.

Definition at line 115 of file MueLu_CoarseMapFactory_decl.hpp.

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

virtual std::vector<size_t> MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getStridingData ( ) const

inlinevirtual

getStridingData returns vector with size of striding blocks in the domain DOF map (= coarse map). e.g. for 2 velocity dofs and 1 pressure dof the vector is (2,1)

Definition at line 131 of file MueLu_CoarseMapFactory_decl.hpp.

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

void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setStridingData ( std::vector< size_t > stridingInfo )

virtual

setStridingData set striding vector for the domain DOF map (= coarse map), e.g. (2,1) for 2 velocity dofs and 1 pressure dof

Definition at line 68 of file MueLu_CoarseMapFactory_def.hpp.

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

virtual LocalOrdinal MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getStridedBlockId ( ) const

inlinevirtual

getStridedBlockId returns strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map)

Definition at line 143 of file MueLu_CoarseMapFactory_decl.hpp.

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

virtual void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setStridedBlockId ( LocalOrdinal stridedBlockId )

inlinevirtual

setStridedBlockId set strided block id for the domain DOF map of Ptent (= coarse map) or -1 if full strided map is stored in the domain map of Ptent (= coarse map)

Definition at line 152 of file MueLu_CoarseMapFactory_decl.hpp.

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

void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildCoarseMap	(	Level &	currentLevel,
		const GlobalOrdinal	domainGIDOffset
	)		const

protectedvirtual

Build the coarse map using the domain GID offset.

Definition at line 88 of file MueLu_CoarseMapFactory_def.hpp.

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

GlobalOrdinal MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDomainGIDOffset ( Level & currentLevel ) const

protectedvirtual

Extract domain GID offset from user data.

Reimplemented in MueLu::BlockedCoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 133 of file MueLu_CoarseMapFactory_def.hpp.

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

void MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CheckForConsistentStridingInformation	(	LocalOrdinal	stridedBlockId,
		const size_t	nullspaceDimension
	)		const

privatevirtual

Definition at line 155 of file MueLu_CoarseMapFactory_def.hpp.

Member Data Documentation

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

std::vector<size_t> MueLu::CoarseMapFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::stridingInfo_

mutableprivate

Vector with size of strided blocks (dofs)

Definition at line 170 of file MueLu_CoarseMapFactory_decl.hpp.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Input

Build methods.

Get/Set functions

Additional Inherited Members

Detailed Description

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

Input/output

User parameters of this factory

Variables provided by this factory

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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