MueLu  Version of the Day
List of all members
MueLu::MatrixAnalysisFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

This class checks matrix properties of A on current level. This factory can be plugged in everywhere in the factory layout of the MueLu preconditioner. It only needs A as input and pipes it through as output. More...

#include <MueLu_MatrixAnalysisFactory_decl.hpp>

Constructors/Destructors.

 MatrixAnalysisFactory ()
 Constructor. More...
 
virtual ~MatrixAnalysisFactory ()
 Destructor. More...
 
RCP< const ParameterList > GetValidParameterList () const
 

Input

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

Build methods.

void Build (Level &fineLevel, Level &coarseLevel) const
 Build an object with this factory. More...
 
void checkVectorEntries (const Teuchos::RCP< Vector > &vec, std::string info) const
 

Detailed Description

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

This class checks matrix properties of A on current level. This factory can be plugged in everywhere in the factory layout of the MueLu preconditioner. It only needs A as input and pipes it through as output.

Input/output of MatrixAnalysisFactory

User parameters of MatrixAnalysisFactory

Parameter type default master.xml validated requested description
A Factory null * * Generating factory of the matrix A

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 MatrixAnalysisFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see MatrixAnalysisFactory::DeclareInput).

Variables provided by MatrixAnalysisFactory

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

Parameter generated by description
A MatrixAnalysisFactory Original operator (without changes)

Definition at line 91 of file MueLu_MatrixAnalysisFactory_decl.hpp.

Constructor & Destructor Documentation

◆ MatrixAnalysisFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::MatrixAnalysisFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatrixAnalysisFactory

Constructor.

Definition at line 64 of file MueLu_MatrixAnalysisFactory_def.hpp.

◆ ~MatrixAnalysisFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::MatrixAnalysisFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~MatrixAnalysisFactory
virtual

Destructor.

Definition at line 68 of file MueLu_MatrixAnalysisFactory_def.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::MatrixAnalysisFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList

Definition at line 71 of file MueLu_MatrixAnalysisFactory_def.hpp.

◆ DeclareInput()

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

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.

Definition at line 80 of file MueLu_MatrixAnalysisFactory_def.hpp.

◆ Build()

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

Build an object with this factory.

Definition at line 85 of file MueLu_MatrixAnalysisFactory_def.hpp.

◆ checkVectorEntries()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::MatrixAnalysisFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::checkVectorEntries ( const Teuchos::RCP< Vector > &  vec,
std::string  info 
) const
private

Definition at line 292 of file MueLu_MatrixAnalysisFactory_def.hpp.

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