MueLu Version of the Day
|
Factory for creating a graph based on a given matrix. More...
#include <MueLu_CoalesceDropFactory_decl.hpp>
Constructors/Destructors. | |
RCP< PreDropFunctionBaseClass > | predrop_ |
CoalesceDropFactory () | |
Constructor. | |
virtual | ~CoalesceDropFactory () |
Destructor. | |
RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
void | DeclareInput (Level ¤tLevel) const |
Input. | |
void | SetPreDropFunction (const RCP< MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &predrop) |
set predrop function | |
void | Build (Level ¤tLevel) const |
Build an object with this factory. | |
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. | |
void | MergeRowsWithDropping (const Matrix &A, const LO row, const ArrayRCP< const SC > &ghostedDiagVals, SC threshold, Array< LO > &cols, const Array< LO > &translation) const |
Teuchos::RCP< Xpetra::Matrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | BlockDiagonalize (Level ¤tLevel, const RCP< Matrix > &A, bool generate_matrix) const |
void | BlockDiagonalizeGraph (const RCP< GraphBase > &inputGraph, const RCP< LocalOrdinalVector > &ghostedBlockNumber, RCP< GraphBase > &outputGraph, RCP< const Import > &importer) const |
Additional Inherited Members | |
![]() | |
SingleLevelFactoryBase () | |
Constructor. | |
virtual | ~SingleLevelFactoryBase () |
Destructor. | |
virtual void | CallBuild (Level &requestedLevel) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
![]() | |
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 |
![]() | |
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 |
![]() | |
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. | |
![]() | |
virtual | ~FactoryAcceptor () |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual void | SetParameterList (const Teuchos::ParameterList ¶mList) |
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 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 () |
![]() | |
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 |
bool | IsAvailable (Level &level, const std::string &varName) const |
![]() | |
static bool | timerSync_ = false |
Factory for creating a graph based on a given matrix.
Factory for creating graphs from matrices with entries selectively dropped.
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:
Additionally, there is a code path for the distance-laplacian mode.
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).
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. |
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 136 of file MueLu_CoalesceDropFactory_decl.hpp.
MueLu::CoalesceDropFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CoalesceDropFactory | ( | ) |
Constructor.
Definition at line 155 of file MueLu_CoalesceDropFactory_def.hpp.
|
inlinevirtual |
Destructor.
Definition at line 149 of file MueLu_CoalesceDropFactory_decl.hpp.
|
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 121 of file MueLu_CoalesceDropFactory_def.hpp.
|
virtual |
Input.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 158 of file MueLu_CoalesceDropFactory_def.hpp.
|
inline |
set predrop function
Definition at line 161 of file MueLu_CoalesceDropFactory_decl.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::SingleLevelFactoryBase.
Definition at line 178 of file MueLu_CoalesceDropFactory_def.hpp.
|
private |
Method to merge rows of matrix for systems of PDEs.
Definition at line 1634 of file MueLu_CoalesceDropFactory_def.hpp.
|
private |
Definition at line 1693 of file MueLu_CoalesceDropFactory_def.hpp.
|
private |
Definition at line 1770 of file MueLu_CoalesceDropFactory_def.hpp.
|
private |
Definition at line 1890 of file MueLu_CoalesceDropFactory_def.hpp.
|
mutableprivate |
Definition at line 171 of file MueLu_CoalesceDropFactory_decl.hpp.