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

factory generates a row- and column permutation operators P and Q such that P*A*Q^T is a (hopefully) diagonal-dominant matrix. It's meant to be used with PermutingSmoother. More...

#include <MueLu_PermutationFactory_decl.hpp>

Constructors/Destructors.

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

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 an object with this factory. More...
 

Detailed Description

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

factory generates a row- and column permutation operators P and Q such that P*A*Q^T is a (hopefully) diagonal-dominant matrix. It's meant to be used with PermutingSmoother.

Definition at line 84 of file MueLu_PermutationFactory_decl.hpp.

Constructor & Destructor Documentation

◆ PermutationFactory()

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

Constructor.

Definition at line 83 of file MueLu_PermutationFactory_def.hpp.

◆ ~PermutationFactory()

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

Destructor.

Definition at line 87 of file MueLu_PermutationFactory_def.hpp.

Member Function Documentation

◆ GetValidParameterList()

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

Definition at line 90 of file MueLu_PermutationFactory_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::PermutationFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level &  currentLevel) 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 104 of file MueLu_PermutationFactory_def.hpp.

◆ Build()

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

Build an object with this factory.

Definition at line 117 of file MueLu_PermutationFactory_def.hpp.

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