Factory for building coarse matrices in an optimized way by prebuilding the coarse graph based on the structuredness of the problem. More...

#include <MueLu_StructuredRAPFactory_decl.hpp>

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

Classes
struct	StencilOffset
struct	FineStencilEntry
struct	FineStencilSpec
struct	StructuredGraphSpec

Build methods.
bool	hasDeclaredInput_
std::vector< RCP< const FactoryBase > >	transferFacts_
	list of user-defined transfer Factories
RCP< MueLu::RAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	rapFactoryDelegate_
void	Build (Level &fineLevel, Level &coarseLevel) const
	Build an object with this factory.
void	AddTransferFactory (const RCP< const FactoryBase > &factory)
	Add transfer factory in the end of list of transfer factories in RepartitionAcFactory.
size_t	NumTransferFactories () const
	Returns number of transfer factories.
void	GetStructuredGraph (RCP< Matrix > &Ac, const RCP< Matrix > P, const Teuchos::Array< LocalOrdinal > &lCoarseNodesPerDim, const StructuredGraphSpec &graphSpec) const
FineStencilSpec	DetectFineStencil (const Matrix &A, int numDimensions, const Teuchos::Array< LocalOrdinal > &lFineNodesPerDim) const
StructuredGraphSpec	DeriveCoarseRAPStencil (const FineStencilSpec &fineStencil, int interpolationOrder) const
StructuredGraphSpec	GetStructuredGraphSpec (const Matrix &A, const Matrix &P, int numDimensions, const Teuchos::Array< LocalOrdinal > &lFineNodesPerDim, int interpolationOrder) const
void	ConfigureRAPFactoryDelegate () const
RCP< const FactoryBase >	GetStructuredMetadataFactory (const std::string &varName) const

Constructors/Destructors.
	StructuredRAPFactory ()
virtual	~StructuredRAPFactory ()=default

Input
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept.
void	DeclareInput (Level &fineLevel, Level &coarseLevel) const
	Input.

Additional Inherited Members
	TwoLevelFactoryBase ()
	Constructor.
virtual	~TwoLevelFactoryBase ()
	Destructor.
virtual void	CallDeclareInput (Level &requestedLevel) const
virtual void	CallBuild (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 ()=default
	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 ()=default
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
virtual const Teuchos::ParameterList &	GetParameterListWithoutValidation () 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::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building coarse matrices in an optimized way by prebuilding the coarse graph based on the structuredness of the problem.

s

Definition at line 38 of file MueLu_StructuredRAPFactory_decl.hpp.

Constructor & Destructor Documentation

◆ StructuredRAPFactory()

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

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

Definition at line 112 of file MueLu_StructuredRAPFactory_def.hpp.

◆ ~StructuredRAPFactory()

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

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

virtualdefault

Member Function Documentation

◆ GetValidParameterList()

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

RCP< const ParameterList > MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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 117 of file MueLu_StructuredRAPFactory_def.hpp.

◆ DeclareInput()

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

void MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput	(	Level &	fineLevel,
		Level &	coarseLevel ) const

virtual

Input.

Specifies the data that this class needs, and the factories that generate that data.

If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 185 of file MueLu_StructuredRAPFactory_def.hpp.

◆ Build()

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

void MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build	(	Level &	fineLevel,
		Level &	coarseLevel ) const

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 1063 of file MueLu_StructuredRAPFactory_def.hpp.

◆ AddTransferFactory()

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

void MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddTransferFactory ( const RCP< const FactoryBase > & factory )

Add transfer factory in the end of list of transfer factories in RepartitionAcFactory.

Transfer factories are derived from TwoLevelFactoryBase and project some data from the fine level to the next coarser level.

Definition at line 1279 of file MueLu_StructuredRAPFactory_def.hpp.

◆ NumTransferFactories()

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

size_t MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NumTransferFactories ( ) const

inline

Returns number of transfer factories.

Definition at line 75 of file MueLu_StructuredRAPFactory_decl.hpp.

◆ GetStructuredGraph()

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

void MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetStructuredGraph	(	RCP< Matrix > &	Ac,
		const RCP< Matrix >	P,
		const Teuchos::Array< LocalOrdinal > &	lCoarseNodesPerDim,
		const StructuredGraphSpec &	graphSpec ) const

Definition at line 526 of file MueLu_StructuredRAPFactory_def.hpp.

◆ DetectFineStencil()

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

StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FineStencilSpec MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DetectFineStencil	(	const Matrix &	A,
		int	numDimensions,
		const Teuchos::Array< LocalOrdinal > &	lFineNodesPerDim ) const

Definition at line 238 of file MueLu_StructuredRAPFactory_def.hpp.

◆ DeriveCoarseRAPStencil()

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

StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::StructuredGraphSpec MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeriveCoarseRAPStencil	(	const FineStencilSpec &	fineStencil,
		int	interpolationOrder ) const

Definition at line 421 of file MueLu_StructuredRAPFactory_def.hpp.

◆ GetStructuredGraphSpec()

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

StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::StructuredGraphSpec MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetStructuredGraphSpec	(	const Matrix &	A,
		const Matrix &	P,
		int	numDimensions,
		const Teuchos::Array< LocalOrdinal > &	lFineNodesPerDim,
		int	interpolationOrder ) const

private

Definition at line 500 of file MueLu_StructuredRAPFactory_def.hpp.

◆ ConfigureRAPFactoryDelegate()

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

void MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ConfigureRAPFactoryDelegate ( ) const

private

Definition at line 150 of file MueLu_StructuredRAPFactory_def.hpp.

◆ GetStructuredMetadataFactory()

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

RCP< const FactoryBase > MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetStructuredMetadataFactory ( const std::string & varName ) const

private

Definition at line 170 of file MueLu_StructuredRAPFactory_def.hpp.

Member Data Documentation

◆ hasDeclaredInput_

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

bool MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasDeclaredInput_

mutableprivate

Definition at line 123 of file MueLu_StructuredRAPFactory_decl.hpp.

◆ transferFacts_

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

std::vector<RCP<const FactoryBase> > MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::transferFacts_

private

list of user-defined transfer Factories

Definition at line 130 of file MueLu_StructuredRAPFactory_decl.hpp.

◆ rapFactoryDelegate_

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

RCP<MueLu::RAPFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::StructuredRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rapFactoryDelegate_

mutableprivate

Definition at line 145 of file MueLu_StructuredRAPFactory_decl.hpp.

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

Classes

Build methods.

Constructors/Destructors.

Input

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StructuredRAPFactory()

◆ ~StructuredRAPFactory()

Member Function Documentation

◆ GetValidParameterList()

◆ DeclareInput()

◆ Build()

◆ AddTransferFactory()

◆ NumTransferFactories()

◆ GetStructuredGraph()

◆ DetectFineStencil()

◆ DeriveCoarseRAPStencil()

◆ GetStructuredGraphSpec()

◆ ConfigureRAPFactoryDelegate()

◆ GetStructuredMetadataFactory()

Member Data Documentation

◆ hasDeclaredInput_

◆ transferFacts_

◆ rapFactoryDelegate_