Builds one-to-one aggregates for all Dirichlet boundary nodes. For some applications this might be necessary. (default = off) More...

#include <MueLu_PreserveDirichletAggregationAlgorithm_decl.hpp>

Inheritance diagram for MueLu::PreserveDirichletAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >:

Constructors/Destructors.
	PreserveDirichletAggregationAlgorithm (const RCP< const FactoryBase > &=Teuchos::null)
	Constructor.

virtual	~PreserveDirichletAggregationAlgorithm ()
	Destructor.

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.

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

std::string	description () const
	Return a simple one-line description of this object.

Additional Inherited Members
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 inherited from MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node >
virtual	~AggregationAlgorithmBase ()
	Destructor.

virtual void	SetupPhase (const ParameterList &params, Teuchos::RCP< const Teuchos::Comm< int > > &comm, LO &numLocalNodes, LO &numNonAggregatedNodes)

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.

Public Member Functions inherited from MueLu::BaseClass
virtual	~BaseClass ()
	Destructor.

Public Member Functions inherited from MueLu::VerboseObject
	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.

Static Public Member Functions inherited from MueLu::VerboseObject
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::PreserveDirichletAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >

Builds one-to-one aggregates for all Dirichlet boundary nodes. For some applications this might be necessary. (default = off)

Idea

Handles Dirichlet boundary nodes with the state Boundary. Depending on the boolean parameter "aggregation: preserve Dirichlet points" one-to-one aggregates with singleton nodes are built for all Dirichlet boundary nodes or the aggregates are just ignored (default behavior). The state of all boundary nodes (state = Boundary) is set to ignored. That means, that these nodes are not considered for further aggregation in the later aggregation phases.

Parameters

Parameter	Meaning
aggregation: preserve Dirichlet points	Boolean parameter stating whether Dirichlet boundary nodes shall be aggregated in singleton aggregates (default: false).

Comments

Only nodes with state BOUNDARY are changed to IGNORED. No other nodes are touched.

Definition at line 49 of file MueLu_PreserveDirichletAggregationAlgorithm_decl.hpp.

Constructor & Destructor Documentation

◆ PreserveDirichletAggregationAlgorithm()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

MueLu::PreserveDirichletAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::PreserveDirichletAggregationAlgorithm ( const RCP< const FactoryBase > & = Teuchos::null )

inline

Constructor.

Definition at line 58 of file MueLu_PreserveDirichletAggregationAlgorithm_decl.hpp.

◆ ~PreserveDirichletAggregationAlgorithm()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inlinevirtual

Destructor.

Definition at line 61 of file MueLu_PreserveDirichletAggregationAlgorithm_decl.hpp.

Member Function Documentation

◆ BuildAggregatesNonKokkos()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

void MueLu::PreserveDirichletAggregationAlgorithm< 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 28 of file MueLu_PreserveDirichletAggregationAlgorithm_def.hpp.

◆ BuildAggregates()

template<class LocalOrdinal , class GlobalOrdinal , class Node >

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

Definition at line 59 of file MueLu_PreserveDirichletAggregationAlgorithm_def.hpp.

◆ description()

template<class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

std::string MueLu::PreserveDirichletAggregationAlgorithm< LocalOrdinal, GlobalOrdinal, Node >::description ( ) const

inlinevirtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 79 of file MueLu_PreserveDirichletAggregationAlgorithm_decl.hpp.

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

Constructors/Destructors.

Aggregation methods.

Additional Inherited Members

Detailed Description

Idea

Parameters

Comments

Constructor & Destructor Documentation

◆ PreserveDirichletAggregationAlgorithm()

◆ ~PreserveDirichletAggregationAlgorithm()

Member Function Documentation

◆ BuildAggregatesNonKokkos()

◆ BuildAggregates()

◆ description()