Factory for building coarse matrices. More...

#include <MueLu_BlockedRAPFactory_decl.hpp>

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

Constructors/Destructors.
	BlockedRAPFactory ()

virtual	~BlockedRAPFactory ()

Input
RCP< const ParameterList >	GetValidParameterList () const
	Return a const parameter list of valid parameters that setParameterList() will accept. More...

void	DeclareInput (Level &fineLevel, Level &coarseLevel) const
	Input. More...

Build methods.
void	Build (Level &fineLevel, Level &coarseLevel) const
	Build an object with this factory. More...

Handling of user-defined transfer factories
void	SetRepairZeroDiagonal (bool const &repair)
	Indicate that zero entries on the diagonal of Ac shall be repaired (i.e. if A(i,i) == 0.0 set A(i,i) = 1.0) More...

void	SetPlausibilityCheck (bool const &check)
	Indicate that a simple plausibility check shall be done for Ac after building RAP. More...

void	AddTransferFactory (const RCP< const FactoryBase > &factory)
	Add transfer factory in the end of list of transfer factories in RepartitionAcFactory. More...

size_t	NumTransferFactories () const
	Returns number of transfer factories. More...

internal plausibility check methods
checks main diagonal entries of (0,0) block. Does not affect entries in (1,1) block!
bool	checkAc_

bool	repairZeroDiagonals_

std::vector< RCP< const FactoryBase > >	transferFacts_
	list of user-defined transfer Factories More...

static void	CheckMainDiagonal (RCP< BlockedCrsMatrix > &bAc, bool repairZeroDiagonals=false)

Additional Inherited Members
Public Member Functions inherited from MueLu::TwoLevelFactoryBase
	TwoLevelFactoryBase ()
	Constructor. More...

virtual	~TwoLevelFactoryBase ()
	Destructor. More...

virtual void	CallDeclareInput (Level &requestedLevel) const

virtual void	CallBuild (Level &requestedLevel) const

Public Member Functions inherited from MueLu::Factory
void	EnableMultipleCallCheck () const
	Constructor. More...

void	DisableMultipleCallCheck () const

void	ResetDebugData () const

Public Member Functions inherited from MueLu::FactoryBase
	FactoryBase ()
	Constructor. More...

virtual	~FactoryBase ()
	Destructor. More...

int	GetID () const
	return unique factory id 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 Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (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 VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () 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

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

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)

Public Member Functions inherited from MueLu::FactoryAcceptor
virtual	~FactoryAcceptor ()

virtual void	SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0
	Configuration. More...

virtual const RCP< const FactoryBase >	GetFactory (const std::string &varName) const =0

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. More...

virtual const Teuchos::ParameterList &	GetParameterList () const

void	SetParameter (const std::string &name, const ParameterEntry &entry)
	Set a parameter directly as a ParameterEntry. More...

const ParameterEntry &	GetParameter (const std::string &name) const
	Retrieves a const entry with the name name. More...

virtual void	GetDocumentation (std::ostream &os) const

Public Member Functions inherited from MueLu::ParameterListAcceptor
	ParameterListAcceptor ()

virtual	~ParameterListAcceptor ()=default

Static Public Member Functions inherited from MueLu::Factory
static void	EnableMultipleCheckGlobally ()

static void	DisableMultipleCheckGlobally ()

Static Public Member Functions inherited from MueLu::VerboseObject
static void	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

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< FancyOStream >	getDefaultOStream ()

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 Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building coarse matrices.

Definition at line 72 of file MueLu_BlockedRAPFactory_decl.hpp.

Constructor & Destructor Documentation

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

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

Definition at line 67 of file MueLu_BlockedRAPFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

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

inlinevirtual

Definition at line 82 of file MueLu_BlockedRAPFactory_decl.hpp.

Member Function Documentation

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

RCP< const ParameterList > MueLu::BlockedRAPFactory< 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.

Implements MueLu::ParameterListAcceptor.

Definition at line 72 of file MueLu_BlockedRAPFactory_def.hpp.

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

void MueLu::BlockedRAPFactory< 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 86 of file MueLu_BlockedRAPFactory_def.hpp.

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

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

virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 100 of file MueLu_BlockedRAPFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

void MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetRepairZeroDiagonal ( bool const & repair )

inline

Indicate that zero entries on the diagonal of Ac shall be repaired (i.e. if A(i,i) == 0.0 set A(i,i) = 1.0)

Definition at line 103 of file MueLu_BlockedRAPFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

void MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetPlausibilityCheck ( bool const & check )

inline

Indicate that a simple plausibility check shall be done for Ac after building RAP.

Definition at line 109 of file MueLu_BlockedRAPFactory_decl.hpp.

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

void MueLu::BlockedRAPFactory< 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 233 of file MueLu_BlockedRAPFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

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

inline

Returns number of transfer factories.

Definition at line 124 of file MueLu_BlockedRAPFactory_decl.hpp.

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

void MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CheckMainDiagonal	(	RCP< BlockedCrsMatrix > &	bAc,
		bool	repairZeroDiagonals = `false`
	)

staticprivate

Definition at line 192 of file MueLu_BlockedRAPFactory_def.hpp.

Member Data Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

bool MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::checkAc_

private

If true, perform a basic plausibility check on Ac (default = false) note, that the repairZeroDiagonals_ flag only is valid for checkAc_ == true

Definition at line 136 of file MueLu_BlockedRAPFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

bool MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::repairZeroDiagonals_

private

If true, the CheckMainDiagonal routine automatically repairs zero entries on main diagonal (default = false) i.e. if A(i,i) == 0.0 set A(i,i) = 1.0 note, that the repairZeroDiagonals_ flag only is valid for checkAc_ == true

Definition at line 141 of file MueLu_BlockedRAPFactory_decl.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>

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

private

list of user-defined transfer Factories

Definition at line 146 of file MueLu_BlockedRAPFactory_decl.hpp.

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

Constructors/Destructors.

Input

Build methods.

Handling of user-defined transfer factories

internal plausibility check methods

Additional Inherited Members

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType> class MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::BlockedRAPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >