minimal container class for storing amalgamation information More...

#include <MueLu_AmalgamationInfo_decl.hpp>

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

Public Member Functions
	AmalgamationInfo (RCP< Array< LO > > rowTranslation, RCP< Array< LO > > colTranslation, RCP< const Map > nodeRowMap, RCP< const Map > nodeColMap, RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > const &columnMap, LO fullblocksize, GO offset, LO blockid, LO nStridedOffset, LO stridedblocksize)

virtual	~AmalgamationInfo ()

std::string	description () const
	Return a simple one-line description of this object. More...

void	print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
	Print the object with some verbosity level to an FancyOStream object. More...

RCP< const Map >	getNodeRowMap () const

RCP< const Map >	getNodeColMap () const
	< returns the node row map for the graph More...

RCP< Array< LO > >	getRowTranslation () const
	< returns the node column map for the graph More...

RCP< Array< LO > >	getColTranslation () const

void	UnamalgamateAggregates (const Aggregates &aggregates, Teuchos::ArrayRCP< LocalOrdinal > &aggStart, Teuchos::ArrayRCP< GlobalOrdinal > &aggToRowMap) const
	UnamalgamateAggregates. More...

void	UnamalgamateAggregatesLO (const Aggregates &aggregates, Teuchos::ArrayRCP< LocalOrdinal > &aggStart, Teuchos::ArrayRCP< LO > &aggToRowMap) const

Teuchos::RCP< Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	ComputeUnamalgamatedImportDofMap (const Aggregates &aggregates) const
	ComputeUnamalgamatedImportDofMap build overlapping dof row map from aggregates needed for overlapping null space. More...

GO	ComputeGlobalDOF (GO const &gNodeID, LO const &k=0) const
	ComputeGlobalDOF return global dof id associated with global node id gNodeID and dof index k. More...

GO	GlobalOffset ()
	returns offset of global dof ids More...

void	GetStridingInformation (LO &fullBlockSize, LO &blockID, LO &stridingOffset, LO &stridedBlockSize, GO &indexBase)
	returns striding information More...

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor. More...

Public Member Functions inherited from MueLu::VerboseObject
	VerboseObject ()

virtual	~VerboseObject ()
	Destructor. More...

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

Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) 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)

virtual EVerbosityLevel	getVerbLevel () const

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	~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 void	describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const

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

virtual std::string	ShortClassName () const
	Return the class name of the object, without template parameters and without namespace. More...

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

amalgamation information variables
RCP< Array< LO > >	rowTranslation_

RCP< Array< LO > >	colTranslation_

RCP< const Map >	nodeRowMap_

RCP< const Map >	nodeColMap_

Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	columnMap_
	DOF map (really column map of A) More...

Strided map information.
LO	fullblocksize_

GO	offset_

LO	blockid_

LO	nStridedOffset_

LO	stridedblocksize_

GO	indexBase_

Additional Inherited Members
Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

static void	SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)

static Teuchos::RCP< Teuchos::FancyOStream >	GetDefaultOStream ()

Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

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

Detailed Description

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >

minimal container class for storing amalgamation information

Helps create a mapping between global node id on current processor to global DOFs ids on current processor. That mapping is used for unamalgamation.

Definition at line 81 of file MueLu_AmalgamationInfo_decl.hpp.

Constructor & Destructor Documentation

◆ AmalgamationInfo()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::AmalgamationInfo	(	RCP< Array< LO > >	rowTranslation,
		RCP< Array< LO > >	colTranslation,
		RCP< const Map >	nodeRowMap,
		RCP< const Map >	nodeColMap,
		RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > const &	columnMap,
		LO	fullblocksize,
		GO	offset,
		LO	blockid,
		LO	nStridedOffset,
		LO	stridedblocksize
	)

inline

Definition at line 88 of file MueLu_AmalgamationInfo_decl.hpp.

◆ ~AmalgamationInfo()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

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

inlinevirtual

Definition at line 107 of file MueLu_AmalgamationInfo_decl.hpp.

Member Function Documentation

◆ description()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

std::string MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 110 of file MueLu_AmalgamationInfo_decl.hpp.

◆ print()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

void MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::print	(	Teuchos::FancyOStream &	out,
		const VerbLevel	verbLevel = `Default`
	)		const

Print the object with some verbosity level to an FancyOStream object.

◆ getNodeRowMap()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<const Map> MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::getNodeRowMap ( ) const

inline

Definition at line 117 of file MueLu_AmalgamationInfo_decl.hpp.

◆ getNodeColMap()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<const Map> MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::getNodeColMap ( ) const

inline

< returns the node row map for the graph

Definition at line 118 of file MueLu_AmalgamationInfo_decl.hpp.

◆ getRowTranslation()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<Array<LO> > MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::getRowTranslation ( ) const

inline

< returns the node column map for the graph

Definition at line 127 of file MueLu_AmalgamationInfo_decl.hpp.

◆ getColTranslation()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<Array<LO> > MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::getColTranslation ( ) const

inline

Definition at line 128 of file MueLu_AmalgamationInfo_decl.hpp.

◆ UnamalgamateAggregates()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::UnamalgamateAggregates	(	const Aggregates &	aggregates,
		Teuchos::ArrayRCP< LocalOrdinal > &	aggStart,
		Teuchos::ArrayRCP< GlobalOrdinal > &	aggToRowMap
	)		const

UnamalgamateAggregates.

Puts all dofs for aggregate i in aggToRowMap[i]. Also calculate aggregate sizes.

Definition at line 66 of file MueLu_AmalgamationInfo_def.hpp.

◆ UnamalgamateAggregatesLO()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::UnamalgamateAggregatesLO	(	const Aggregates &	aggregates,
		Teuchos::ArrayRCP< LocalOrdinal > &	aggStart,
		Teuchos::ArrayRCP< LO > &	aggToRowMap
	)		const

Definition at line 134 of file MueLu_AmalgamationInfo_def.hpp.

◆ ComputeUnamalgamatedImportDofMap()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::ComputeUnamalgamatedImportDofMap ( const Aggregates & aggregates ) const

ComputeUnamalgamatedImportDofMap build overlapping dof row map from aggregates needed for overlapping null space.

Definition at line 204 of file MueLu_AmalgamationInfo_def.hpp.

◆ ComputeGlobalDOF()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

GlobalOrdinal MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::ComputeGlobalDOF	(	GO const &	gNodeID,
		LO const &	k = `0`
	)		const

ComputeGlobalDOF return global dof id associated with global node id gNodeID and dof index k.

Parameters

(GO)	global node id
(LO)	local dof index within node

Returns: (GO): global dof id

Definition at line 233 of file MueLu_AmalgamationInfo_def.hpp.

◆ GlobalOffset()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

GO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::GlobalOffset ( )

inline

returns offset of global dof ids

Access routines

Definition at line 155 of file MueLu_AmalgamationInfo_decl.hpp.

◆ GetStridingInformation()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

void MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::GetStridingInformation	(	LO &	fullBlockSize,
		LO &	blockID,
		LO &	stridingOffset,
		LO &	stridedBlockSize,
		GO &	indexBase
	)

inline

returns striding information

Definition at line 158 of file MueLu_AmalgamationInfo_decl.hpp.

Member Data Documentation

◆ rowTranslation_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<Array<LO> > MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::rowTranslation_

private

Definition at line 172 of file MueLu_AmalgamationInfo_decl.hpp.

◆ colTranslation_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<Array<LO> > MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::colTranslation_

private

Definition at line 173 of file MueLu_AmalgamationInfo_decl.hpp.

◆ nodeRowMap_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<const Map> MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::nodeRowMap_

private

Definition at line 176 of file MueLu_AmalgamationInfo_decl.hpp.

◆ nodeColMap_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

RCP<const Map> MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::nodeColMap_

private

Definition at line 177 of file MueLu_AmalgamationInfo_decl.hpp.

◆ columnMap_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

Teuchos::RCP< const Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> > MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::columnMap_

private

DOF map (really column map of A)

Definition at line 181 of file MueLu_AmalgamationInfo_decl.hpp.

◆ fullblocksize_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

LO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::fullblocksize_

private

Definition at line 187 of file MueLu_AmalgamationInfo_decl.hpp.

◆ offset_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

GO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::offset_

private

Definition at line 188 of file MueLu_AmalgamationInfo_decl.hpp.

◆ blockid_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

LO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::blockid_

private

Definition at line 189 of file MueLu_AmalgamationInfo_decl.hpp.

◆ nStridedOffset_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

LO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::nStridedOffset_

private

Definition at line 190 of file MueLu_AmalgamationInfo_decl.hpp.

◆ stridedblocksize_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

LO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::stridedblocksize_

private

Definition at line 191 of file MueLu_AmalgamationInfo_decl.hpp.

◆ indexBase_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

GO MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >::indexBase_

private

Definition at line 192 of file MueLu_AmalgamationInfo_decl.hpp.

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

Public Member Functions

amalgamation information variables

Strided map information.

Additional Inherited Members

Detailed Description

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType> class MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >

Constructor & Destructor Documentation

◆ AmalgamationInfo()

◆ ~AmalgamationInfo()

Member Function Documentation

◆ description()

◆ print()

◆ getNodeRowMap()

◆ getNodeColMap()

◆ getRowTranslation()

◆ getColTranslation()

◆ UnamalgamateAggregates()

◆ UnamalgamateAggregatesLO()

◆ ComputeUnamalgamatedImportDofMap()

◆ ComputeGlobalDOF()

◆ GlobalOffset()

◆ GetStridingInformation()

Member Data Documentation

◆ rowTranslation_

◆ colTranslation_

◆ nodeRowMap_

◆ nodeColMap_

◆ columnMap_

◆ fullblocksize_

◆ offset_

◆ blockid_

◆ nStridedOffset_

◆ stridedblocksize_

◆ indexBase_

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::AmalgamationInfo< LocalOrdinal, GlobalOrdinal, Node >