MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node > Class Template Referenceabstract

Pure virtual base class for all MueLu aggregation algorithms. More...

#include <MueLu_AggregationAlgorithmBase.hpp>

Inheritance diagram for MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >:
MueLu::BaseClass MueLu::VerboseObject MueLu::Describable

Public Types

using LWGraphHostType = LWGraph
using AggStatHostType = Kokkos::View<unsigned*, typename LWGraphHostType::device_type>
using LWGraphType = LWGraph_kokkos
using AggStatType = Kokkos::View<unsigned*, typename LWGraphType::device_type>

Constructors/Destructors

virtual ~AggregationAlgorithmBase ()
 Destructor.

Build routines

virtual void BuildAggregatesNonKokkos (const Teuchos::ParameterList &params, const LWGraphHostType &graph, Aggregates &aggregates, AggStatHostType &aggStat, LO &numNonAggregatedNodes) const =0
 BuildAggregatesNonKokkos routine.
virtual void BuildAggregates (const Teuchos::ParameterList &params, const LWGraphType &graph, Aggregates &aggregates, AggStatType &aggStat, LO &numNonAggregatedNodes) const =0
 BuildAggregates routine.

Additional Inherited Members

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.
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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >

Pure virtual base class for all MueLu aggregation algorithms.

Definition at line 32 of file MueLu_AggregationAlgorithmBase.hpp.

Member Typedef Documentation

◆ LWGraphHostType

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::LWGraphHostType = LWGraph

Definition at line 36 of file MueLu_AggregationAlgorithmBase.hpp.

◆ AggStatHostType

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType = Kokkos::View<unsigned*, typename LWGraphHostType::device_type>

Definition at line 37 of file MueLu_AggregationAlgorithmBase.hpp.

◆ LWGraphType

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::LWGraphType = LWGraph_kokkos

Definition at line 39 of file MueLu_AggregationAlgorithmBase.hpp.

◆ AggStatType

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType = Kokkos::View<unsigned*, typename LWGraphType::device_type>

Definition at line 40 of file MueLu_AggregationAlgorithmBase.hpp.

Constructor & Destructor Documentation

◆ ~AggregationAlgorithmBase()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::~AggregationAlgorithmBase ( )
inlinevirtual

Destructor.

Definition at line 46 of file MueLu_AggregationAlgorithmBase.hpp.

Member Function Documentation

◆ BuildAggregatesNonKokkos()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual void MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregatesNonKokkos ( const Teuchos::ParameterList & params,
const LWGraphHostType & graph,
Aggregates & aggregates,
AggStatHostType & aggStat,
LO & numNonAggregatedNodes ) const
pure virtual

BuildAggregatesNonKokkos routine.

◆ BuildAggregates()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual void MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregates ( const Teuchos::ParameterList & params,
const LWGraphType & graph,
Aggregates & aggregates,
AggStatType & aggStat,
LO & numNonAggregatedNodes ) const
pure virtual

BuildAggregates routine.

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