MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

An factory which assigns each aggregate a quality estimate. Originally developed by Napov and Notay in the context of plain aggregation, while this quality estimate does not correspond to a robust convergence guarentee (as it does for plain aggregation), we find empirically that it is a good way of discovering poorly constructed aggregates even in the smoothed aggregation context. More...

#include <MueLu_AggregateQualityEstimateFactory_decl.hpp>

Inheritance diagram for MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

RCP< const ParameterListGetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor. More...
 
virtual ~SingleLevelFactoryBase ()
 Destructor. More...
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (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::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
 
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 ParameterEntryGetParameter (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
 

Constructors/Destructors.

typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 
magnitudeType
 
 AggregateQualityEstimateFactory ()
 Constructor. More...
 
virtual ~AggregateQualityEstimateFactory ()
 Destructor. More...
 

Input

void DeclareInput (Level &currentLevel) const
 Specifies the data that this class needs, and the factories that generate that data. More...
 

Build methods.

void Build (Level &currentLevel) const
 Build aggregate quality esimates with this factory. More...
 

Utility method to convert aggregate data to a convenient format.

static void ConvertAggregatesData (RCP< const Aggregates > aggs, ArrayRCP< LO > &aggSortedVertices, ArrayRCP< LO > &aggsToIndices, ArrayRCP< LO > &aggSizes)
 Build aggregate quality esimates with this factory. More...
 

Internal method for computing aggregate quality.

void ComputeAggregateQualities (RCP< const Matrix > A, RCP< const Aggregates > aggs, RCP< Xpetra::MultiVector< magnitudeType, LO, GO, Node >> agg_qualities) const
 

Internal method for outputting aggregate quality

void OutputAggQualities (const Level &level, RCP< const Xpetra::MultiVector< magnitudeType, LO, GO, Node >> agg_qualities) const
 

Additional Inherited Members

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

An factory which assigns each aggregate a quality estimate. Originally developed by Napov and Notay in the context of plain aggregation, while this quality estimate does not correspond to a robust convergence guarentee (as it does for plain aggregation), we find empirically that it is a good way of discovering poorly constructed aggregates even in the smoothed aggregation context.

Napov, A., & Notay, Y. (2012). An algebraic multigrid method with guaranteed convergence rate. SIAM journal on scientific computing, 34(2), A1079-A1109.

Definition at line 86 of file MueLu_AggregateQualityEstimateFactory_decl.hpp.

Member Typedef Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::magnitudeType

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AggregateQualityEstimateFactory ( )

Constructor.

Definition at line 68 of file MueLu_AggregateQualityEstimateFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~AggregateQualityEstimateFactory ( )
virtual

Destructor.

Definition at line 72 of file MueLu_AggregateQualityEstimateFactory_def.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::AggregateQualityEstimateFactory< 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 84 of file MueLu_AggregateQualityEstimateFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level currentLevel) const
virtual

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::SingleLevelFactoryBase.

Definition at line 75 of file MueLu_AggregateQualityEstimateFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level currentLevel) const
virtual

Build aggregate quality esimates with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 106 of file MueLu_AggregateQualityEstimateFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ConvertAggregatesData ( RCP< const Aggregates aggs,
ArrayRCP< LO > &  aggSortedVertices,
ArrayRCP< LO > &  aggsToIndices,
ArrayRCP< LO > &  aggSizes 
)
static

Build aggregate quality esimates with this factory.

Definition at line 126 of file MueLu_AggregateQualityEstimateFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ComputeAggregateQualities ( RCP< const Matrix >  A,
RCP< const Aggregates aggs,
RCP< Xpetra::MultiVector< magnitudeType, LO, GO, Node >>  agg_qualities 
) const
private
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::AggregateQualityEstimateFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::OutputAggQualities ( const Level level,
RCP< const Xpetra::MultiVector< magnitudeType, LO, GO, Node >>  agg_qualities 
) const
private

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