#include <MueLu_BrickAggregationFactory_decl.hpp>

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

Classes
class	compare

Private Types
typedef Teuchos::ScalarTraits< Scalar >	STS
typedef std::map< Scalar, GlobalOrdinal, compare >	container

Build methods.
int	nDim_
RCP< container >	xMap_
RCP< container >	yMap_
RCP< container >	zMap_
ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType >	x_
ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType >	y_
ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType >	z_
int	nx_
int	ny_
int	nz_
int	bx_
int	by_
int	bz_
bool	dirichletX_
bool	dirichletY_
bool	dirichletZ_
int	naggx_
int	naggy_
int	naggz_
std::map< GlobalOrdinal, GlobalOrdinal >	revMap_
void	Build (Level &currentLevel) const
	Build aggregates.
void	Setup (const RCP< const Teuchos::Comm< int > > &comm, const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LO, GO, NO > > &coords, const RCP< const Map > &map) const
RCP< container >	Construct1DMap (const RCP< const Teuchos::Comm< int > > &comm, const ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &x) const
void	BuildGraph (Level &currentLevel, const RCP< Matrix > &A) const
bool	isDirichlet (LocalOrdinal LID) const
bool	isRoot (LocalOrdinal LID) const
GlobalOrdinal	getRoot (LocalOrdinal LID) const
GlobalOrdinal	getAggGID (LocalOrdinal LID) const
void	getIJK (LocalOrdinal LID, int &i, int &j, int &k) const
void	getAggIJK (LocalOrdinal LID, int &i, int &j, int &k) const

Constructors/Destructors.
	BrickAggregationFactory ()
	Constructor.
virtual	~BrickAggregationFactory ()
	Destructor.
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.
void	DeclareInput (Level &currentLevel) const
	Input.

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 = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 48 of file MueLu_BrickAggregationFactory_decl.hpp.

Member Typedef Documentation

◆ STS

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

typedef Teuchos::ScalarTraits<Scalar> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::STS

private

Definition at line 52 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ container

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

typedef std::map<Scalar, GlobalOrdinal, compare> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::container

private

Definition at line 68 of file MueLu_BrickAggregationFactory_decl.hpp.

Constructor & Destructor Documentation

◆ BrickAggregationFactory()

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

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

inline

Constructor.

Definition at line 75 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ ~BrickAggregationFactory()

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

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

inlinevirtual

Destructor.

Definition at line 85 of file MueLu_BrickAggregationFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > BrickAggregationFactory::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 40 of file MueLu_BrickAggregationFactory_def.hpp.

◆ DeclareInput()

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

void BrickAggregationFactory::DeclareInput ( Level & currentLevel ) const

virtual

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 58 of file MueLu_BrickAggregationFactory_def.hpp.

◆ Build()

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

void BrickAggregationFactory::Build ( Level & currentLevel ) const

virtual

Build aggregates.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 108 of file MueLu_BrickAggregationFactory_def.hpp.

◆ Setup()

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

void BrickAggregationFactory::Setup	(	const RCP< const Teuchos::Comm< int > > &	comm,
		const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::magnitudeType, LO, GO, NO > > &	coords,
		const RCP< const Map > &	map ) const

private

Definition at line 251 of file MueLu_BrickAggregationFactory_def.hpp.

◆ Construct1DMap()

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

RCP< typename BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::container > BrickAggregationFactory::Construct1DMap	(	const RCP< const Teuchos::Comm< int > > &	comm,
		const ArrayRCP< const typename Teuchos::ScalarTraits< Scalar >::magnitudeType > &	x ) const

private

Definition at line 302 of file MueLu_BrickAggregationFactory_def.hpp.

◆ BuildGraph()

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

void BrickAggregationFactory::BuildGraph	(	Level &	currentLevel,
		const RCP< Matrix > &	A ) const

private

Definition at line 445 of file MueLu_BrickAggregationFactory_def.hpp.

◆ isDirichlet()

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

bool BrickAggregationFactory::isDirichlet ( LocalOrdinal LID ) const

private

Definition at line 359 of file MueLu_BrickAggregationFactory_def.hpp.

◆ isRoot()

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

bool BrickAggregationFactory::isRoot ( LocalOrdinal LID ) const

private

Definition at line 351 of file MueLu_BrickAggregationFactory_def.hpp.

◆ getRoot()

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

GlobalOrdinal BrickAggregationFactory::getRoot ( LocalOrdinal LID ) const

private

Definition at line 374 of file MueLu_BrickAggregationFactory_def.hpp.

◆ getAggGID()

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

GlobalOrdinal BrickAggregationFactory::getAggGID ( LocalOrdinal LID ) const

private

Definition at line 419 of file MueLu_BrickAggregationFactory_def.hpp.

◆ getIJK()

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

void BrickAggregationFactory::getIJK	(	LocalOrdinal	LID,
		int &	i,
		int &	j,
		int &	k ) const

private

Definition at line 392 of file MueLu_BrickAggregationFactory_def.hpp.

◆ getAggIJK()

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

void BrickAggregationFactory::getAggIJK	(	LocalOrdinal	LID,
		int &	i,
		int &	j,
		int &	k ) const

private

Definition at line 399 of file MueLu_BrickAggregationFactory_def.hpp.

Member Data Documentation

◆ nDim_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nDim_

mutableprivate

Definition at line 122 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ xMap_

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

RCP<container> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::xMap_

mutableprivate

Definition at line 123 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ yMap_

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

RCP<container> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::yMap_

private

Definition at line 123 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ zMap_

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

RCP<container> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::zMap_

private

Definition at line 123 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ x_

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

ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::x_

mutableprivate

Definition at line 124 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ y_

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

ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::y_

private

Definition at line 124 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ z_

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

ArrayRCP<const typename Teuchos::ScalarTraits<Scalar>::magnitudeType> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::z_

private

Definition at line 124 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ nx_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nx_

mutableprivate

Definition at line 125 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ ny_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ny_

private

Definition at line 125 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ nz_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nz_

private

Definition at line 125 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ bx_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bx_

mutableprivate

Definition at line 126 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ by_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::by_

private

Definition at line 126 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ bz_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bz_

private

Definition at line 126 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ dirichletX_

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

bool MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dirichletX_

mutableprivate

Definition at line 127 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ dirichletY_

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

bool MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dirichletY_

private

Definition at line 127 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ dirichletZ_

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

bool MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::dirichletZ_

private

Definition at line 127 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ naggx_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::naggx_

mutableprivate

Definition at line 128 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ naggy_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::naggy_

private

Definition at line 128 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ naggz_

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

int MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::naggz_

private

Definition at line 128 of file MueLu_BrickAggregationFactory_decl.hpp.

◆ revMap_

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

std::map<GlobalOrdinal, GlobalOrdinal> MueLu::BrickAggregationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::revMap_

mutableprivate

Definition at line 130 of file MueLu_BrickAggregationFactory_decl.hpp.

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

Classes

Private Types

Build methods.

Constructors/Destructors.

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ STS

◆ container

Constructor & Destructor Documentation

◆ BrickAggregationFactory()

◆ ~BrickAggregationFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ Setup()

◆ Construct1DMap()

◆ BuildGraph()

◆ isDirichlet()

◆ isRoot()

◆ getRoot()

◆ getAggGID()

◆ getIJK()

◆ getAggIJK()

Member Data Documentation

◆ nDim_

◆ xMap_

◆ yMap_

◆ zMap_

◆ x_

◆ y_

◆ z_

◆ nx_

◆ ny_

◆ nz_

◆ bx_

◆ by_

◆ bz_

◆ dirichletX_

◆ dirichletY_

◆ dirichletZ_

◆ naggx_

◆ naggy_

◆ naggz_

◆ revMap_