MueLu  Version of the Day
MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Algorithm for coarsening a graph with structured aggregation. More...

#include <MueLu_AggregationStructuredAlgorithm_decl.hpp>

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

Public Member Functions

std::string description () const
 Return a simple one-line description of this object. More...
 
- Public Member Functions inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
virtual ~AggregationAlgorithmBase ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
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
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. 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...
 

Private Member Functions

void ComputeGraphDataConstant (const GraphBase &graph, RCP< IndexManager > &geoData, const int numInterpolationPoints, ArrayRCP< size_t > &nnzOnRow, Array< size_t > &rowPtr, Array< LO > &colIndex) const
 
void ComputeGraphDataLinear (const GraphBase &graph, RCP< IndexManager > &geoData, const int numInterpolationPoints, ArrayRCP< size_t > &nnzOnRow, Array< size_t > &rowPtr, Array< LO > &colIndex) const
 

Constructors/Destructors.

 AggregationStructuredAlgorithm (const RCP< const FactoryBase > &graphFact=Teuchos::null)
 Constructor. More...
 
virtual ~AggregationStructuredAlgorithm ()
 Destructor. More...
 

Aggregation methods.

void BuildAggregates (const Teuchos::ParameterList &params, const GraphBase &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const
 Local aggregation. More...
 
void BuildGraph (const GraphBase &graph, RCP< IndexManager > &geoData, RCP< CrsGraph > &myGraph, RCP< const Map > &coarseCoordinatesFineMap, RCP< const Map > &coarseCoordinatesMap) const
 Local aggregation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 

Detailed Description

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

Algorithm for coarsening a graph with structured aggregation.

Idea

Use the logical indexing of the mesh to obtain a very regular aggregation pattern and maintain lines and planes of the problem as they might be useful to the smoother. This algorithms is also very easy to parallelize on node due to its very regular and predictible memory access patern.

Parameters

Parameter Meaning
aggregation: coarsen describe the coarsening rate to be used in each direction

Definition at line 80 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

Constructor & Destructor Documentation

◆ AggregationStructuredAlgorithm()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::AggregationStructuredAlgorithm ( const RCP< const FactoryBase > &  graphFact = Teuchos::null)
inline

Constructor.

Definition at line 90 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

◆ ~AggregationStructuredAlgorithm()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::~AggregationStructuredAlgorithm ( )
inlinevirtual

Destructor.

Definition at line 93 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

Member Function Documentation

◆ BuildAggregates()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregates ( const Teuchos::ParameterList &  params,
const GraphBase graph,
Aggregates aggregates,
std::vector< unsigned > &  aggStat,
LO &  numNonAggregatedNodes 
) const
virtual

◆ BuildGraph()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildGraph ( const GraphBase graph,
RCP< IndexManager > &  geoData,
RCP< CrsGraph > &  myGraph,
RCP< const Map > &  coarseCoordinatesFineMap,
RCP< const Map > &  coarseCoordinatesMap 
) const

Local aggregation.

Definition at line 132 of file MueLu_AggregationStructuredAlgorithm_def.hpp.

◆ description()

template<class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::string MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 114 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

◆ ComputeGraphDataConstant()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::ComputeGraphDataConstant ( const GraphBase graph,
RCP< IndexManager > &  geoData,
const int  numInterpolationPoints,
ArrayRCP< size_t > &  nnzOnRow,
Array< size_t > &  rowPtr,
Array< LO > &  colIndex 
) const
private

◆ ComputeGraphDataLinear()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::ComputeGraphDataLinear ( const GraphBase graph,
RCP< IndexManager > &  geoData,
const int  numInterpolationPoints,
ArrayRCP< size_t > &  nnzOnRow,
Array< size_t > &  rowPtr,
Array< LO > &  colIndex 
) const
private

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