Factory for creating a graph based on a given matrix. More...

#include <MueLu_CoalesceDropFactory_kokkos_decl.hpp>

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

Public Types
using	local_ordinal_type = LocalOrdinal
using	global_ordinal_type = GlobalOrdinal
using	execution_space = typename Node::execution_space
using	range_type = Kokkos::RangePolicy<local_ordinal_type, execution_space>
using	node_type = Node

Private Types
using	boundary_nodes_type = typename MueLu::LWGraph_kokkos<LocalOrdinal, GlobalOrdinal, Node>::boundary_nodes_type

Constructors/Destructors.
	CoalesceDropFactory_kokkos ()
	Constructor.
virtual	~CoalesceDropFactory_kokkos ()
	Destructor.
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.
void	DeclareInput (Level &currentLevel) const
	Input.
void	Build (Level &currentLevel) const
	Build an object with this factory.
std::tuple< RCP< LocalOrdinalVector >, RCP< LocalOrdinalVector > >	GetBlockNumberMVs (Level &currentLevel) const
std::tuple< GlobalOrdinal, boundary_nodes_type >	BuildScalar (Level &currentLevel) const
std::tuple< GlobalOrdinal, boundary_nodes_type >	BuildVector (Level &currentLevel) const

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
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, class LocalOrdinal, class GlobalOrdinal, class Node>
class MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for creating a graph based on a given matrix.

Factory for creating graphs from matrices with entries selectively dropped. This factory combines the functionality of CoalesceDropFactory and FilteredAFactory from the non-Kokkos code path.

For an in-depth discussion, see https://github.com/trilinos/Trilinos/issues/1676.

Code paths

Both the classic dropping strategy as well as a coordinate-based distance laplacian method is implemented. For performance reasons there are four distinctive code paths for the classical method:

one DOF per node without dropping (i.e. "aggregation: drop tol" = 0.0)
one DOF per node with dropping (i.e. "aggregation: drop tol" > 0.0)
DOFs per node > 1 withouth dropping
DOFs per node > 1 with dropping

Additionally there is a code path for the distance-laplacian mode.

Input/output of CoalesceDropFactory_kokkos

User parameters of CoalesceDropFactory_kokkos

Parameter	type	default	master.xml	validated	requested	description
A	Factory	null		*	*	Generating factory of the operator A
UnAmalgamationInfo	Factory	null		*	*	Generating factory of type AmalgamationFactory which generates the variable 'UnAmalgamationInfo'. Do not change the default unless you know what you are doing.
Coordinates	Factory	null		*	(*)	Generating factory for variable 'Coordinates'. The coordinates are only needed if "distance laplacian" is chosen for the parameter "aggregation: drop scheme"
"aggregation: drop scheme"	std::string	"classical"	*	*		Coalescing algorithm. You can choose either "classical" (=default) or "distance laplacian"
"aggregation: drop tol"	double	0.0	*	*		Threshold parameter for dropping small entries
"aggregation: Dirichlet threshold"	double	0.0	*	*		Threshold for determining whether entries are zero during Dirichlet row detection
"lightweight wrap"	bool	true		*		hidden switch between fast implementation based on MueLu::LWGraph and a failsafe slower implementation based on Xpetra::Graph (for comparison). The user should not change the default value (=true)

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

Variables provided by UncoupledAggregationFactory

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

Parameter	generated by	description
Graph	CoalesceDropFactory_kokkos	Graph of matrix A
DofsPerNode	CoalesceDropFactory_kokkos	number of DOFs per node. Note, that we assume a constant number of DOFs per node for all nodes associated with the operator A.

Amalgamation process

The CoalesceDropFactory_kokkos is internally using the AmalgamationFactory for amalgamating the dof-based maps to node-based maps. The AmalgamationFactory creates the "UnAmalgamationInfo" container which basically stores all the necessary information for translating dof based data to node based data and vice versa. The container is used, since this way the amalgamation is only done once and later reused by other factories.

Of course, often one does not need the information from the "UnAmalgamationInfo" container since the same information could be extracted of the "Graph" or the map from the "Coordinates" vector. However, there are also some situations (e.g. when doing rebalancing based on HyperGraph partitioning without coordinate information) where one has not access to a "Graph" or "Coordinates" variable.

Definition at line 95 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

Member Typedef Documentation

◆ local_ordinal_type

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

using MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type = LocalOrdinal

Definition at line 98 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

◆ global_ordinal_type

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

using MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type = GlobalOrdinal

Definition at line 99 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

◆ execution_space

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

using MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::execution_space = typename Node::execution_space

Definition at line 100 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

◆ range_type

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

using MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::range_type = Kokkos::RangePolicy<local_ordinal_type, execution_space>

Definition at line 101 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

◆ node_type

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

using MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type = Node

Definition at line 102 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

◆ boundary_nodes_type

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

using MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::boundary_nodes_type = typename MueLu::LWGraph_kokkos<LocalOrdinal, GlobalOrdinal, Node>::boundary_nodes_type

private

Definition at line 105 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

Constructor & Destructor Documentation

◆ CoalesceDropFactory_kokkos()

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

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

inline

Constructor.

Definition at line 116 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

◆ ~CoalesceDropFactory_kokkos()

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

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

inlinevirtual

Destructor.

Definition at line 119 of file MueLu_CoalesceDropFactory_kokkos_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > MueLu::CoalesceDropFactory_kokkos< Scalar, 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 41 of file MueLu_CoalesceDropFactory_kokkos_def.hpp.

◆ DeclareInput()

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

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

virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 88 of file MueLu_CoalesceDropFactory_kokkos_def.hpp.

◆ Build()

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

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

virtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 108 of file MueLu_CoalesceDropFactory_kokkos_def.hpp.

◆ GetBlockNumberMVs()

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

std::tuple< Teuchos::RCP< Xpetra::Vector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > >, Teuchos::RCP< Xpetra::Vector< LocalOrdinal, LocalOrdinal, GlobalOrdinal, Node > > > MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetBlockNumberMVs ( Level & currentLevel ) const

Definition at line 152 of file MueLu_CoalesceDropFactory_kokkos_def.hpp.

◆ BuildScalar()

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

std::tuple< GlobalOrdinal, typename MueLu::LWGraph_kokkos< LocalOrdinal, GlobalOrdinal, Node >::boundary_nodes_type > MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildScalar ( Level & currentLevel ) const

Definition at line 172 of file MueLu_CoalesceDropFactory_kokkos_def.hpp.

◆ BuildVector()

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

std::tuple< GlobalOrdinal, typename MueLu::LWGraph_kokkos< LocalOrdinal, GlobalOrdinal, Node >::boundary_nodes_type > MueLu::CoalesceDropFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildVector ( Level & currentLevel ) const

Definition at line 872 of file MueLu_CoalesceDropFactory_kokkos_def.hpp.

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

Public Types

Private Types

Constructors/Destructors.

Additional Inherited Members

Detailed Description

Code paths

Input/output of CoalesceDropFactory_kokkos

User parameters of CoalesceDropFactory_kokkos

Variables provided by UncoupledAggregationFactory

Amalgamation process

Member Typedef Documentation

◆ local_ordinal_type

◆ global_ordinal_type

◆ execution_space

◆ range_type

◆ node_type

◆ boundary_nodes_type

Constructor & Destructor Documentation

◆ CoalesceDropFactory_kokkos()

◆ ~CoalesceDropFactory_kokkos()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ GetBlockNumberMVs()

◆ BuildScalar()

◆ BuildVector()