AmalgamationFactory for subblocks of strided map based amalgamation data. More...

#include <MueLu_AmalgamationFactory_decl.hpp>

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

Private Types
using	AmalgamationInfo = MueLu::AmalgamationInfo<LocalOrdinal, GlobalOrdinal, Node>

Constructors/Destructors.
	AmalgamationFactory ()
	Constructor.
virtual	~AmalgamationFactory ()
	Destructor.
RCP< const ParameterList >	GetValidParameterList () const override
	Return a const parameter list of valid parameters that setParameterList() will accept.
void	DeclareInput (Level &currentLevel) const override
	Input.
void	Build (Level &currentLevel) const override
	Build an object with this factory.
static const GlobalOrdinal	DOFGid2NodeId (GlobalOrdinal gid, LocalOrdinal blockSize, const GlobalOrdinal offset, const GlobalOrdinal indexBase)
	Translate global (row/column) id to global amalgamation block id.
static const GlobalOrdinal	DOFGidOffset (RCP< const StridedMap > stridedMap)
	Method to calculate the global (row) id offset from scratch.
static void	AmalgamateMap (const Map &sourceMap, const Matrix &A, RCP< const Map > &amalgamatedMap, Array< LO > &translation)
	Method to create merged map for systems of PDEs.
static void	AmalgamateMap (RCP< const StridedMap > sourceMap, RCP< const Map > &amalgamatedMap)
	Method to create merged map for systems of PDEs.

Additional Inherited Members
	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
virtual	~BaseClass ()
	Destructor.
	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
	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 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::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

AmalgamationFactory for subblocks of strided map based amalgamation data.

Class generates unamalgamation information using matrix A with strided maps. It stores the output information within an AmalgamationInfo object as "UnAmalgamationInfo". This object contains

nodegid2dofgids_ a map of all node ids of which the current proc has corresponding DOF gids (used by TentativePFactory).
gNodeIds vector of all node ids on the current proc (may be less than nodegid2dofgids_.size()). These nodes are stored on the current proc.

Definition at line 42 of file MueLu_AmalgamationFactory_decl.hpp.

Member Typedef Documentation

◆ AmalgamationInfo

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

using MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AmalgamationInfo = MueLu::AmalgamationInfo<LocalOrdinal, GlobalOrdinal, Node>

private

Constructor & Destructor Documentation

◆ AmalgamationFactory()

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

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

default

Constructor.

◆ ~AmalgamationFactory()

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

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

virtualdefault

Destructor.

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > MueLu::AmalgamationFactory< 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 30 of file MueLu_AmalgamationFactory_def.hpp.

◆ DeclareInput()

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

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

overridevirtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 37 of file MueLu_AmalgamationFactory_def.hpp.

◆ Build()

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

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

overridevirtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 42 of file MueLu_AmalgamationFactory_def.hpp.

◆ DOFGid2NodeId()

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

const GlobalOrdinal MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DOFGid2NodeId	(	GlobalOrdinal	gid,
		LocalOrdinal	blockSize,
		const GlobalOrdinal	offset,
		const GlobalOrdinal	indexBase )

static

Translate global (row/column) id to global amalgamation block id.

Note: Assume that the node map has the same indexBase as the dof map

Parameters

gid	(GlobalOrdinal): input global id (row gid or column gid)
blockSize	(LocalOrdinal): block size (needed for constant block size)
offset	(GlobalOrdinal): global offset for dofs (stored in strided map, default = 0)
indexBase	(GlobalOrdinal): indexBase for DOF map (and node map, default = 0)

Definition at line 224 of file MueLu_AmalgamationFactory_def.hpp.

◆ DOFGidOffset()

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

const GlobalOrdinal MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DOFGidOffset ( RCP< const StridedMap > stridedMap )

static

Method to calculate the global (row) id offset from scratch.

Parameters

stridedMap (const StridedMap&): strided map of operator A (matrix)

Definition at line 231 of file MueLu_AmalgamationFactory_def.hpp.

◆ AmalgamateMap() [1/2]

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

void MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AmalgamateMap	(	const Map &	sourceMap,
		const Matrix &	A,
		RCP< const Map > &	amalgamatedMap,
		Array< LO > &	translation )

static

Method to create merged map for systems of PDEs.

Parameters

sourceMap	(const Map&): source map with dofs which shall be amalgamated to a node map
A	(const Matrix&): operator A (matrix) with striding information (if available)
amalgamatedMap	(const Map&): amalgamated node based map
translation	(Array<LO>&): array storing local node ids given local dof ids (needed in CoalesceDropFactory)

Definition at line 153 of file MueLu_AmalgamationFactory_def.hpp.

◆ AmalgamateMap() [2/2]

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

void MueLu::AmalgamationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AmalgamateMap	(	RCP< const StridedMap >	sourceMap,
		RCP< const Map > &	amalgamatedMap )

static

Method to create merged map for systems of PDEs.

Parameters

sourceMap	(const StridedMap): source map with dofs which shall be amalgamated to a node map
amalgamatedMap	(const Map&): amalgamated node based map

Definition at line 199 of file MueLu_AmalgamationFactory_def.hpp.

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

Private Types

Constructors/Destructors.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AmalgamationInfo

Constructor & Destructor Documentation

◆ AmalgamationFactory()

◆ ~AmalgamationFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ DOFGid2NodeId()

◆ DOFGidOffset()

◆ AmalgamateMap() [1/2]

◆ AmalgamateMap() [2/2]