MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Classes

struct  computeGraphDataConstantFunctor
 
struct  computeGraphDataLinearFunctor
 
struct  computeGraphRowPtrFunctor
 
struct  fillAggregatesFunctor
 

Public Types

using local_graph_type = typename LWGraph_kokkos::local_graph_type
 
using non_const_row_map_type = typename local_graph_type::row_map_type::non_const_type
 
using size_type = typename local_graph_type::size_type
 
using entries_type = typename local_graph_type::entries_type
 
using device_type = typename local_graph_type::device_type
 
using execution_space = typename local_graph_type::device_type::execution_space
 
using memory_space = typename local_graph_type::device_type::memory_space
 
using LOVectorView = decltype(std::declval< LOVector >().getDeviceLocalView(Xpetra::Access::ReadWrite))
 
using constIntTupleView = typename Kokkos::View< const int[3], device_type >
 
using constLOTupleView = typename Kokkos::View< const LO[3], device_type >
 
- Public Types inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
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 >
 

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...
 
virtual void BuildAggregatesNonKokkos (const Teuchos::ParameterList &params, const LWGraphHostType &graph, Aggregates &aggregates, AggStatHostType &aggStat, LO &numNonAggregatedNodes) const =0
 BuildAggregatesNonKokkos routine. More...
 
virtual void BuildAggregates (const Teuchos::ParameterList &params, const LWGraphType &graph, Aggregates &aggregates, AggStatType &aggStat, LO &numNonAggregatedNodes) const =0
 BuildAggregates routine. 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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () 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)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () 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 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...
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 

Private Member Functions

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

Constructors/Destructors.

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

Aggregation methods.

void BuildAggregatesNonKokkos (const Teuchos::ParameterList &params, const LWGraph &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType &aggStat, LO &numNonAggregatedNodes) const
 Local aggregation. More...
 
void BuildGraphOnHost (const LWGraph &graph, RCP< IndexManager > &geoData, const LO dofsPerNode, RCP< CrsGraph > &myGraph, RCP< const Map > &coarseCoordinatesFineMap, RCP< const Map > &coarseCoordinatesMap) const
 Local aggregation. More...
 
void BuildAggregates (const Teuchos::ParameterList &params, const LWGraph_kokkos &graph, Aggregates &aggregates, typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType &aggStat, LO &numNonAggregatedNodes) const
 Build aggregates object. More...
 
void BuildGraph (const LWGraph_kokkos &graph, RCP< IndexManager_kokkos > &geoData, const LO dofsPerNode, RCP< CrsGraph > &myGraph) const
 Build a CrsGraph instead of aggregates. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static void SetMueLuOFileStream (const std::string &filename)
 
static Teuchos::RCP
< Teuchos::FancyOStream
GetMueLuOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- 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 = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
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 84 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

Member Typedef Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::local_graph_type = typename LWGraph_kokkos::local_graph_type
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::non_const_row_map_type = typename local_graph_type::row_map_type::non_const_type
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::size_type = typename local_graph_type::size_type
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::entries_type = typename local_graph_type::entries_type
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::device_type = typename local_graph_type::device_type
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::execution_space = typename local_graph_type::device_type::execution_space
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::memory_space = typename local_graph_type::device_type::memory_space
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::LOVectorView = decltype(std::declval<LOVector>().getDeviceLocalView(Xpetra::Access::ReadWrite))
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::constIntTupleView = typename Kokkos::View<const int[3], device_type>
template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
using MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::constLOTupleView = typename Kokkos::View<const LO[3], device_type>

Constructor & Destructor Documentation

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::AggregationStructuredAlgorithm ( const RCP< const FactoryBase > &  = Teuchos::null)
inline

Constructor.

Definition at line 104 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

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

Destructor.

Definition at line 107 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregatesNonKokkos ( const Teuchos::ParameterList params,
const LWGraph graph,
Aggregates aggregates,
typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatHostType aggStat,
LO numNonAggregatedNodes 
) const

Local aggregation.

Definition at line 71 of file MueLu_AggregationStructuredAlgorithm_def.hpp.

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

Local aggregation.

Definition at line 140 of file MueLu_AggregationStructuredAlgorithm_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildAggregates ( const Teuchos::ParameterList params,
const LWGraph_kokkos graph,
Aggregates aggregates,
typename AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >::AggStatType aggStat,
LO numNonAggregatedNodes 
) const

Build aggregates object.

Definition at line 427 of file MueLu_AggregationStructuredAlgorithm_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::BuildGraph ( const LWGraph_kokkos graph,
RCP< IndexManager_kokkos > &  geoData,
const LO  dofsPerNode,
RCP< CrsGraph > &  myGraph 
) const

Build a CrsGraph instead of aggregates.

Definition at line 467 of file MueLu_AggregationStructuredAlgorithm_def.hpp.

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
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 143 of file MueLu_AggregationStructuredAlgorithm_decl.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::ComputeGraphDataConstant ( const LWGraph graph,
RCP< IndexManager > &  geoData,
const LO  dofsPerNode,
const int  numInterpolationPoints,
ArrayRCP< size_t > &  nnzOnRow,
Array< size_t > &  rowPtr,
Array< LO > &  colIndex 
) const
private
template<class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregationStructuredAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::ComputeGraphDataLinear ( const LWGraph graph,
RCP< IndexManager > &  geoData,
const LO  dofsPerNode,
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: