#include <MueLu_Aggregates_decl.hpp>

Inheritance diagram for MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >:

Public Types
using	local_ordinal_type = LocalOrdinal
using	global_ordinal_type = GlobalOrdinal
using	execution_space = typename DeviceType::execution_space
using	node_type = Tpetra::KokkosCompat::KokkosDeviceWrapperNode<DeviceType>
using	device_type = DeviceType
using	range_type = Kokkos::RangePolicy<local_ordinal_type, execution_space>
using	LO_view = Kokkos::View<local_ordinal_type*, device_type>
using	aggregates_sizes_type = Kokkos::View<LocalOrdinal*, device_type>
using	local_graph_type = typename LWGraph_kokkos::local_graph_type
using	colors_view_type

Public Member Functions
	Aggregates (const GraphBase &graph)
	Standard constructor for Aggregates structure.
	Aggregates (LWGraph_kokkos graph)
	Standard constructor for Aggregates structure.
	Aggregates (const RCP< const Map > &map)
	Constructor for Aggregates structure.
virtual	~Aggregates ()
	Destructor.
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
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.

Private Types
typedef node_type	Node
using	GraphBase = MueLu::GraphBase<LocalOrdinal,GlobalOrdinal,Node>

Overridden from Teuchos::Describable
LO	numAggregates_
	Number of aggregates on this processor.
GO	numGlobalAggregates_
	Number of global aggregates.
RCP< LOMultiVector >	vertex2AggId_
RCP< LOVector >	procWinner_
RCP< IndexManager_kokkos >	geoDataKokkos_
RCP< IndexManager >	geoData_
colors_view_type	graphColors_
LO	graphNumColors_
Teuchos::ArrayRCP< bool >	isRoot_
	An ArrayRCP of booleans specifying if a local entry is an aggregate root.
bool	aggregatesIncludeGhosts_
	Set to false iff aggregates do not include any DOFs belong to other processes.
aggregates_sizes_type	aggregateSizes_
	Array of sizes of each local aggregate.
aggregates_sizes_type::HostMirror	aggregateSizesHost_
local_graph_type	graph_
	Aggregates represented as Kokkos graph type.
std::string	description () const
	Return a simple one-line description of this object.
void	print (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object.

Set/Get Methods for specific aggregation data
RCP< IndexManager_kokkos > &	GetIndexManagerKokkos ()
	Get the index manager used by structured aggregation algorithms. This has to be done by the aggregation factory.
void	SetIndexManagerKokkos (RCP< IndexManager_kokkos > &geoDataKokkos)
	Set the index manager used by structured aggregation algorithms. This has to be done by the aggregation factory.
RCP< IndexManager > &	GetIndexManager ()
	Get the index manager used by various aggregation algorithms. This has to be done by the aggregation factory.
void	SetIndexManager (RCP< IndexManager > &geoData)
	Set the index manager used by various aggregation algorithms. This has to be done by the aggregation factory.
colors_view_type &	GetGraphColors ()
	Get a distance 2 coloring of the underlying graph. The coloring is computed and set during Phase1 of aggregation.
void	SetGraphColors (colors_view_type graphColors)
	Set a distance 2 coloring of the underlying graph. The coloring is computed and set during Phase1 of aggregation.
LO	GetGraphNumColors ()
	Get the number of colors needed by the distance 2 coloring.
void	SetGraphNumColors (const LO graphNumColors)
	Set the number of colors needed by the distance 2 coloring.
void	SetNumAggregates (LO nAggregates)
	Set number of local aggregates on current processor.
void	SetNumGlobalAggregates (GO nGlobalAggregates)
	Set number of global aggregates on current processor.
KOKKOS_INLINE_FUNCTION LO	GetNumAggregates () const
KOKKOS_INLINE_FUNCTION void	AggregatesCrossProcessors (const bool &flag)
	Record whether aggregates include DOFs from other processes.
KOKKOS_INLINE_FUNCTION bool	AggregatesCrossProcessors () const
	Return false if and only if no aggregates include DOFs from other processes.
RCP< LOMultiVector > &	GetVertex2AggIdNonConst ()
	Returns a nonconstant vector that maps local node IDs to local aggregates IDs.
RCP< LOVector > &	GetProcWinnerNonConst ()
	Returns nonconstant vector that maps local node IDs to owning processor IDs.
const RCP< LOMultiVector > &	GetVertex2AggId () const
	Returns constant vector that maps local node IDs to local aggregates IDs.
const RCP< LOVector > &	GetProcWinner () const
	Returns constant vector that maps local node IDs to owning processor IDs.
bool	IsRoot (LO i) const
	Returns true if node with given local node id is marked to be a root node.
void	SetIsRoot (LO i, bool value=true)
	Set root node information.
const RCP< const Map >	GetMap () const
	returns (overlapping) map of aggregate/node distribution
aggregates_sizes_type::const_type	ComputeAggregateSizes (bool forceRecompute=false) const
	Compute sizes of aggregates.
Teuchos::ArrayRCP< LocalOrdinal >	ComputeAggregateSizesArrayRCP (bool forceRecompute=false) const
	Compute sizes of aggregates.
local_graph_type	GetGraph () const
void	ComputeNodesInAggregate (LO_view &aggPtr, LO_view &aggNodes, LO_view &unaggregated) const
	Generates a compressed list of nodes in each aggregate, where the entries in aggNodes[aggPtr[i]] up to aggNodes[aggPtr[i+1]-1] contain the nodes in aggregate i. unaggregated contains the list of nodes which are, for whatever reason, not aggregated (e.g. Dirichlet).
GO	GetNumGlobalAggregatesComputeIfNeeded ()
	Get global number of aggregates.

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

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>
class MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >

Definition at line 109 of file MueLu_Aggregates_decl.hpp.

Member Typedef Documentation

◆ local_ordinal_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::local_ordinal_type = LocalOrdinal

Definition at line 111 of file MueLu_Aggregates_decl.hpp.

◆ global_ordinal_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::global_ordinal_type = GlobalOrdinal

Definition at line 112 of file MueLu_Aggregates_decl.hpp.

◆ execution_space

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::execution_space = typename DeviceType::execution_space

Definition at line 113 of file MueLu_Aggregates_decl.hpp.

◆ node_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::node_type = Tpetra::KokkosCompat::KokkosDeviceWrapperNode<DeviceType>

Definition at line 114 of file MueLu_Aggregates_decl.hpp.

◆ device_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::device_type = DeviceType

Definition at line 115 of file MueLu_Aggregates_decl.hpp.

◆ range_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::range_type = Kokkos::RangePolicy<local_ordinal_type, execution_space>

Definition at line 116 of file MueLu_Aggregates_decl.hpp.

◆ LO_view

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::LO_view = Kokkos::View<local_ordinal_type*, device_type>

Definition at line 117 of file MueLu_Aggregates_decl.hpp.

◆ aggregates_sizes_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::aggregates_sizes_type = Kokkos::View<LocalOrdinal*, device_type>

Definition at line 119 of file MueLu_Aggregates_decl.hpp.

◆ Node

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

typedef node_type MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::Node

private

Definition at line 123 of file MueLu_Aggregates_decl.hpp.

◆ GraphBase

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GraphBase = MueLu::GraphBase<LocalOrdinal,GlobalOrdinal,Node>

private

◆ local_graph_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::local_graph_type = typename LWGraph_kokkos::local_graph_type

Definition at line 130 of file MueLu_Aggregates_decl.hpp.

◆ colors_view_type

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

using MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::colors_view_type

Initial value:

Kokkos::View<typename local_graph_type::entries_type::data_type,

typename local_graph_type::device_type::memory_space>

Definition at line 131 of file MueLu_Aggregates_decl.hpp.

Constructor & Destructor Documentation

◆ Aggregates() [1/3]

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::Aggregates ( const GraphBase & graph )

Standard constructor for Aggregates structure.

Standard constructor of aggregates takes a Graph object as parameter. Uses the graph.GetImportMap() to initialize the internal vector for mapping nodes to (local) aggregate ids as well as the mapping of node to the owning processor id.

Definition at line 63 of file MueLu_Aggregates_def.hpp.

◆ Aggregates() [2/3]

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::Aggregates ( LWGraph_kokkos graph )

Standard constructor for Aggregates structure.

Standard constructor of aggregates takes a LWGraph object as parameter. Uses the graph.GetImportMap() to initialize the internal vector for mapping nodes to (local) aggregate ids as well as the mapping of node to the owning processor id.

Definition at line 80 of file MueLu_Aggregates_def.hpp.

◆ Aggregates() [3/3]

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::Aggregates ( const RCP< const Map > & map )

Constructor for Aggregates structure.

This constructor takes a RCP pointer to a map which is used for the internal mappings of nodes to the (local) aggregate ids and the owning processor.

Definition at line 98 of file MueLu_Aggregates_def.hpp.

◆ ~Aggregates()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

virtual MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::~Aggregates ( )

inlinevirtual

Destructor.

Definition at line 162 of file MueLu_Aggregates_decl.hpp.

Member Function Documentation

◆ GetIndexManagerKokkos()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP< IndexManager_kokkos > & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetIndexManagerKokkos ( )

inline

Get the index manager used by structured aggregation algorithms. This has to be done by the aggregation factory.

Definition at line 170 of file MueLu_Aggregates_decl.hpp.

◆ SetIndexManagerKokkos()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetIndexManagerKokkos ( RCP< IndexManager_kokkos > & geoDataKokkos )

inline

Set the index manager used by structured aggregation algorithms. This has to be done by the aggregation factory.

Definition at line 175 of file MueLu_Aggregates_decl.hpp.

◆ GetIndexManager()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP< IndexManager > & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetIndexManager ( )

inline

Get the index manager used by various aggregation algorithms. This has to be done by the aggregation factory.

Definition at line 180 of file MueLu_Aggregates_decl.hpp.

◆ SetIndexManager()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetIndexManager ( RCP< IndexManager > & geoData )

inline

Set the index manager used by various aggregation algorithms. This has to be done by the aggregation factory.

Definition at line 185 of file MueLu_Aggregates_decl.hpp.

◆ GetGraphColors()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

colors_view_type & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetGraphColors ( )

inline

Get a distance 2 coloring of the underlying graph. The coloring is computed and set during Phase1 of aggregation.

Definition at line 190 of file MueLu_Aggregates_decl.hpp.

◆ SetGraphColors()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetGraphColors ( colors_view_type graphColors )

inline

Set a distance 2 coloring of the underlying graph. The coloring is computed and set during Phase1 of aggregation.

Definition at line 195 of file MueLu_Aggregates_decl.hpp.

◆ GetGraphNumColors()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

LO MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetGraphNumColors ( )

inline

Get the number of colors needed by the distance 2 coloring.

Definition at line 199 of file MueLu_Aggregates_decl.hpp.

◆ SetGraphNumColors()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetGraphNumColors ( const LO graphNumColors )

inline

Set the number of colors needed by the distance 2 coloring.

Definition at line 203 of file MueLu_Aggregates_decl.hpp.

◆ SetNumAggregates()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetNumAggregates ( LO nAggregates )

inline

Set number of local aggregates on current processor.

This has to be done by the aggregation routines.

Definition at line 211 of file MueLu_Aggregates_decl.hpp.

◆ SetNumGlobalAggregates()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetNumGlobalAggregates ( GO nGlobalAggregates )

inline

Set number of global aggregates on current processor.

This has to be done by the aggregation routines. returns the number of aggregates of the current processor. Note: could/should be renamed to GetNumLocalAggregates?

Definition at line 217 of file MueLu_Aggregates_decl.hpp.

◆ GetNumAggregates()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

KOKKOS_INLINE_FUNCTION LO MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetNumAggregates ( ) const

inline

Definition at line 220 of file MueLu_Aggregates_decl.hpp.

◆ AggregatesCrossProcessors() [1/2]

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

KOKKOS_INLINE_FUNCTION void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::AggregatesCrossProcessors ( const bool & flag )

inline

Record whether aggregates include DOFs from other processes.

Definition at line 225 of file MueLu_Aggregates_decl.hpp.

◆ AggregatesCrossProcessors() [2/2]

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

KOKKOS_INLINE_FUNCTION bool MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::AggregatesCrossProcessors ( ) const

inline

Return false if and only if no aggregates include DOFs from other processes.

Used in construction of tentative prolongator to skip a communication phase.

Definition at line 233 of file MueLu_Aggregates_decl.hpp.

◆ GetVertex2AggIdNonConst()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP< LOMultiVector > & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetVertex2AggIdNonConst ( )

inline

Returns a nonconstant vector that maps local node IDs to local aggregates IDs.

For local node ID i, the corresponding vector entry v[i] is the local aggregate id to which i belongs on the current processor.

Definition at line 241 of file MueLu_Aggregates_decl.hpp.

◆ GetProcWinnerNonConst()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP< LOVector > & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetProcWinnerNonConst ( )

inline

Returns nonconstant vector that maps local node IDs to owning processor IDs.

For local node ID i, the corresponding vector entry v[i] is the owning processor ID.

Definition at line 247 of file MueLu_Aggregates_decl.hpp.

◆ GetVertex2AggId()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

const RCP< LOMultiVector > & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetVertex2AggId ( ) const

inline

Returns constant vector that maps local node IDs to local aggregates IDs.

For local node ID i, the corresponding vector entry v[i] is the local aggregate id to which i belongs on the current processor.

Definition at line 252 of file MueLu_Aggregates_decl.hpp.

◆ GetProcWinner()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

const RCP< LOVector > & MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetProcWinner ( ) const

inline

Returns constant vector that maps local node IDs to owning processor IDs.

For local node ID i, the corresponding vector entry v[i] is the owning processor ID.

Definition at line 258 of file MueLu_Aggregates_decl.hpp.

◆ IsRoot()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

bool MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::IsRoot ( LO i ) const

inline

Returns true if node with given local node id is marked to be a root node.

Definition at line 261 of file MueLu_Aggregates_decl.hpp.

◆ SetIsRoot()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::SetIsRoot	(	LO	i,
		bool	value = true )

inline

Set root node information.

Used by aggregation methods only.

Definition at line 267 of file MueLu_Aggregates_decl.hpp.

◆ GetMap()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

const RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > > > MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetMap ( ) const

returns (overlapping) map of aggregate/node distribution

Definition at line 306 of file MueLu_Aggregates_def.hpp.

◆ ComputeAggregateSizes()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::aggregates_sizes_type::const_type MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::ComputeAggregateSizes ( bool forceRecompute = false ) const

Compute sizes of aggregates.

Returns the number of nodes in each aggregate in an array. If the aggregate sizes are not stored internally (which is the default), they are computed and returned. If the aggregate sizes have been stored internally, then they are not recomputed, but instead the stored sizes are returned.

Parameters

[in] forceRecompute if true, force recomputation of the aggregate sizes.

Definition at line 117 of file MueLu_Aggregates_def.hpp.

◆ ComputeAggregateSizesArrayRCP()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

Teuchos::ArrayRCP< LocalOrdinal > MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::ComputeAggregateSizesArrayRCP ( bool forceRecompute = false ) const

Compute sizes of aggregates.

Returns the number of nodes in each aggregate in an array. If the aggregate sizes are not stored internally (which is the default), they are computed and returned. If the aggregate sizes have been stored internally, then they are not recomputed, but instead the stored sizes are returned.

Parameters

[in] forceRecompute if true, force recomputation of the aggregate sizes.

Definition at line 146 of file MueLu_Aggregates_def.hpp.

◆ GetGraph()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::local_graph_type MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetGraph ( ) const

Definition at line 168 of file MueLu_Aggregates_def.hpp.

◆ ComputeNodesInAggregate()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::ComputeNodesInAggregate	(	LO_view &	aggPtr,
		LO_view &	aggNodes,
		LO_view &	unaggregated ) const

Generates a compressed list of nodes in each aggregate, where the entries in aggNodes[aggPtr[i]] up to aggNodes[aggPtr[i+1]-1] contain the nodes in aggregate i. unaggregated contains the list of nodes which are, for whatever reason, not aggregated (e.g. Dirichlet).

Definition at line 226 of file MueLu_Aggregates_def.hpp.

◆ GetNumGlobalAggregatesComputeIfNeeded()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

GlobalOrdinal MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::GetNumGlobalAggregatesComputeIfNeeded ( )

Get global number of aggregates.

Definition at line 293 of file MueLu_Aggregates_def.hpp.

◆ description()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

std::string MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::description ( ) const

virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 277 of file MueLu_Aggregates_def.hpp.

◆ print()

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

void MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::print	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = verbLevel_default ) const

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

Definition at line 283 of file MueLu_Aggregates_def.hpp.

Member Data Documentation

◆ numAggregates_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

LO MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::numAggregates_

private

Number of aggregates on this processor.

Definition at line 316 of file MueLu_Aggregates_decl.hpp.

◆ numGlobalAggregates_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

GO MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::numGlobalAggregates_

private

Number of global aggregates.

Definition at line 317 of file MueLu_Aggregates_decl.hpp.

◆ vertex2AggId_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP<LOMultiVector> MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::vertex2AggId_

private

vertex2AggId[k] gives a local id corresponding to the aggregate to which local id k has been assigned. While k is the local id on my processor (MyPID), vertex2AggId[k] is the local id on the processor which actually owns the aggregate.

Definition at line 323 of file MueLu_Aggregates_decl.hpp.

◆ procWinner_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP<LOVector> MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::procWinner_

private

If k is the local id on my processor (MyPID), the owning processor has the id given by procWinner[k]

Definition at line 329 of file MueLu_Aggregates_decl.hpp.

◆ geoDataKokkos_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP<IndexManager_kokkos> MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::geoDataKokkos_

private

geoData stores an index manager object that is used to perform structured aggreation on a problem.

Definition at line 334 of file MueLu_Aggregates_decl.hpp.

◆ geoData_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

RCP<IndexManager> MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::geoData_

private

geoData stores an index manager object that is used to perform structured aggreation on a problem.

Definition at line 339 of file MueLu_Aggregates_decl.hpp.

◆ graphColors_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

colors_view_type MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::graphColors_

private

graphColors_ stores a view that assigns a color to each node in the graph These colors are used to parallelize the aggregation process in UncoupledAggregation

Definition at line 344 of file MueLu_Aggregates_decl.hpp.

◆ graphNumColors_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

LO MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::graphNumColors_

private

graphNumColors_ stores the number of colors that are needed to perform a distance 2 coloring of the underlying graph.

Definition at line 349 of file MueLu_Aggregates_decl.hpp.

◆ isRoot_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

Teuchos::ArrayRCP<bool> MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::isRoot_

private

An ArrayRCP of booleans specifying if a local entry is an aggregate root.

Definition at line 352 of file MueLu_Aggregates_decl.hpp.

◆ aggregatesIncludeGhosts_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

bool MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::aggregatesIncludeGhosts_

private

Set to false iff aggregates do not include any DOFs belong to other processes.

Definition at line 355 of file MueLu_Aggregates_decl.hpp.

◆ aggregateSizes_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

aggregates_sizes_type MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::aggregateSizes_

mutableprivate

Array of sizes of each local aggregate.

Definition at line 359 of file MueLu_Aggregates_decl.hpp.

◆ aggregateSizesHost_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

aggregates_sizes_type::HostMirror MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::aggregateSizesHost_

mutableprivate

aggragateSizesHost_ is a host copy of aggregate sizes, which helps slightly reduce the cost of calling ComputeAggregateSizes from different parts of MueLu that require such data on the host device.

Definition at line 366 of file MueLu_Aggregates_decl.hpp.

◆ graph_

template<class LocalOrdinal, class GlobalOrdinal, class DeviceType>

local_graph_type MueLu::Aggregates< LocalOrdinal, GlobalOrdinal, Tpetra::KokkosCompat::KokkosDeviceWrapperNode< DeviceType > >::graph_

mutableprivate

Aggregates represented as Kokkos graph type.

Definition at line 370 of file MueLu_Aggregates_decl.hpp.

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

Public Types

Public Member Functions

Private Types

Overridden from Teuchos::Describable

Set/Get Methods for specific aggregation data

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ local_ordinal_type

◆ global_ordinal_type

◆ execution_space

◆ node_type

◆ device_type

◆ range_type

◆ LO_view

◆ aggregates_sizes_type

◆ Node

◆ GraphBase

◆ local_graph_type

◆ colors_view_type

Constructor & Destructor Documentation

◆ Aggregates() [1/3]

◆ Aggregates() [2/3]

◆ Aggregates() [3/3]

◆ ~Aggregates()

Member Function Documentation

◆ GetIndexManagerKokkos()

◆ SetIndexManagerKokkos()

◆ GetIndexManager()

◆ SetIndexManager()

◆ GetGraphColors()

◆ SetGraphColors()

◆ GetGraphNumColors()

◆ SetGraphNumColors()

◆ SetNumAggregates()

◆ SetNumGlobalAggregates()

◆ GetNumAggregates()

◆ AggregatesCrossProcessors() [1/2]

◆ AggregatesCrossProcessors() [2/2]

◆ GetVertex2AggIdNonConst()

◆ GetProcWinnerNonConst()

◆ GetVertex2AggId()

◆ GetProcWinner()

◆ IsRoot()

◆ SetIsRoot()

◆ GetMap()

◆ ComputeAggregateSizes()

◆ ComputeAggregateSizesArrayRCP()

◆ GetGraph()

◆ ComputeNodesInAggregate()

◆ GetNumGlobalAggregatesComputeIfNeeded()

◆ description()

◆ print()

Member Data Documentation

◆ numAggregates_

◆ numGlobalAggregates_

◆ vertex2AggId_

◆ procWinner_

◆ geoDataKokkos_

◆ geoData_

◆ graphColors_

◆ graphNumColors_

◆ isRoot_

◆ aggregatesIncludeGhosts_

◆ aggregateSizes_

◆ aggregateSizesHost_

◆ graph_