MueLu  Version of the Day
MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory for creating a graph base on a given matrix. More...

#include <MueLu_CoalesceDropFactory_decl.hpp>

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

Public Member Functions

void Build (Level &currentLevel) const
 Build an object with this factory. 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
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
 Factory ()
 Constructor. More...
 
virtual ~Factory ()
 Destructor. More...
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration. More...
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory() More...
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) 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 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 MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()
 
virtual void SetParameterList (const 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 ()
 

Private Member Functions

void MergeRows (const Matrix &A, const LO row, Array< LO > &cols, const Array< LO > &translation) const
 Method to merge rows of matrix for systems of PDEs. More...
 
void MergeRowsWithDropping (const Matrix &A, const LO row, const ArrayRCP< const SC > &ghostedDiagVals, SC threshold, Array< LO > &cols, const Array< LO > &translation) const
 

Private Attributes

RCP< PreDropFunctionBaseClasspredrop_
 

Constructors/Destructors.

 CoalesceDropFactory ()
 Constructor. More...
 
virtual ~CoalesceDropFactory ()
 Destructor. More...
 
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 
void DeclareInput (Level &currentLevel) const
 Input. More...
 
void SetPreDropFunction (const RCP< MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &predrop)
 set predrop function More...
 

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 SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- 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 >
Get (Level &level, const std::string &varName) const
 
template<class 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
 
bool IsAvailable (Level &level, const std::string &varName) const
 

Detailed Description

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

Factory for creating a graph base on a given matrix.

Factory for creating graphs from matrices with entries selectively dropped.

Code paths

Both the classic dropping strategy as well as a coordinate-based distance laplacian method is implemented. For performance reasons there are four distinctive code paths for the classical method:

  • one DOF per node without dropping (i.e. "aggregation: drop tol" = 0.0)
  • one DOF per node with dropping (i.e. "aggregation: drop tol" > 0.0)
  • DOFs per node > 1 withouth dropping
  • DOFs per node > 1 with dropping

Additionally there is a code path for the distance-laplacian mode.

Input/output of CoalesceDropFactory

User parameters of CoalesceDropFactory

Parameter type default master.xml validated requested description
A Factory null * * Generating factory of the operator A
UnAmalgamationInfo Factory null * * Generating factory of type AmalgamationFactory which generates the variable 'UnAmalgamationInfo'. Do not change the default unless you know what you are doing.
Coordinates Factory null * (*) Generating factory for variable 'Coordinates'. The coordinates are only needed if "distance laplacian" is chosen for the parameter "aggregation: drop scheme"
"aggregation: drop scheme" std::string "classical" * * Coalescing algorithm. You can choose either "classical" (=default) or "distance laplacian"
"aggregation: drop tol" double 0.0 * * Threshold parameter for dropping small entries
"aggregation: Dirichlet threshold" double 0.0 * * Threshold for determining whether entries are zero during Dirichlet row detection
"lightweight wrap" bool true * hidden switch between fast implementation based on MueLu::LWGraph and a failsafe slower implementation based on Xpetra::Graph (for comparison). The user should not change the default value (=true)

The * in the master.xml column denotes that the parameter is defined in the master.xml file.
The * in the validated column means that the parameter is declared in the list of valid input parameters (see CoalesceDropFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see CoalesceDropFactory::DeclareInput).

Variables provided by UncoupledAggregationFactory

After CoalesceDropFactory::Build the following data is available (if requested)

Parameter generated by description
Graph CoalesceDropFactory Graph of matrix A
DofsPerNode CoalesceDropFactory number of DOFs per node. Note, that we assume a constant number of DOFs per node for all nodes associated with the operator A.

Amalgamation process

The CoalesceDropFactory is internally using the AmalgamationFactory for amalgamating the dof-based maps to node-based maps. The AmalgamationFactory creates the "UnAmalgamationInfo" container which basically stores all the necessary information for translating dof based data to node based data and vice versa. The container is used, since this way the amalgamation is only done once and later reused by other factories.

Of course, often one does not need the information from the "UnAmalgamationInfo" container since the same information could be extracted of the "Graph" or the map from the "Coordinates" vector. However, there are also some situations (e.g. when doing rebalancing based on HyperGraph partitioning without coordinate information) where one has not access to a "Graph" or "Coordinates" variable.

Definition at line 135 of file MueLu_CoalesceDropFactory_decl.hpp.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 102 of file MueLu_CoalesceDropFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~CoalesceDropFactory ( )
inlinevirtual

Destructor.

Definition at line 148 of file MueLu_CoalesceDropFactory_decl.hpp.

Member Function Documentation

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

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

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 105 of file MueLu_CoalesceDropFactory_def.hpp.

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetPreDropFunction ( const RCP< MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  predrop)
inline

set predrop function

Definition at line 160 of file MueLu_CoalesceDropFactory_decl.hpp.

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

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 118 of file MueLu_CoalesceDropFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MergeRows ( const Matrix &  A,
const LO  row,
Array< LO > &  cols,
const Array< LO > &  translation 
) const
private

Method to merge rows of matrix for systems of PDEs.

Definition at line 876 of file MueLu_CoalesceDropFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MergeRowsWithDropping ( const Matrix &  A,
const LO  row,
const ArrayRCP< const SC > &  ghostedDiagVals,
SC  threshold,
Array< LO > &  cols,
const Array< LO > &  translation 
) const
private

Definition at line 935 of file MueLu_CoalesceDropFactory_def.hpp.

Member Data Documentation

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<PreDropFunctionBaseClass> MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::predrop_
mutableprivate

Definition at line 170 of file MueLu_CoalesceDropFactory_decl.hpp.


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