DFT-EFE
 
Loading...
Searching...
No Matches
dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace > Class Template Reference

Class to encapsulate the NONE preconditioner. Just takes in a vector and returns it. More...

#include <PreconditionerNone.h>

Inheritance diagram for dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >:
Collaboration diagram for dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >:

Public Types

using ValueTypeUnion = blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand >
 
- Public Types inherited from dftefe::linearAlgebra::Preconditioner< ValueTypeOperator, ValueTypeOperand, memorySpace >
using ValueTypeUnion = blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand >
 
- Public Types inherited from dftefe::linearAlgebra::OperatorContext< ValueTypeOperator, ValueTypeOperand, memorySpace >
using ValueTypeUnion = blasLapack::scalar_type< ValueTypeOperator, ValueTypeOperand >
 

Public Member Functions

 PreconditionerNone ()
 Constructor. More...
 
 ~PreconditionerNone ()=default
 Default Destructor. More...
 
void apply (MultiVector< ValueTypeOperand, memorySpace > &X, MultiVector< ValueTypeUnion, memorySpace > &Y) const override
 
PreconditionerType getPreconditionerType () const override
 
- Public Member Functions inherited from dftefe::linearAlgebra::Preconditioner< ValueTypeOperator, ValueTypeOperand, memorySpace >
 ~Preconditioner ()=default
 Default Destructor. More...
 
virtual void apply (MultiVector< ValueTypeOperand, memorySpace > &X, MultiVector< ValueTypeUnion, memorySpace > &Y) const =0
 
virtual PreconditionerType getPreconditionerType () const =0
 
- Public Member Functions inherited from dftefe::linearAlgebra::OperatorContext< ValueTypeOperator, ValueTypeOperand, memorySpace >
 ~OperatorContext ()=default
 Default Destructor. More...
 
virtual void apply (MultiVector< ValueTypeOperand, memorySpace > &X, MultiVector< ValueTypeUnion, memorySpace > &Y) const =0
 

Private Attributes

PreconditionerType d_pcType
 

Detailed Description

template<typename ValueTypeOperator, typename ValueTypeOperand, utils::MemorySpace memorySpace>
class dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >

Class to encapsulate the NONE preconditioner. Just takes in a vector and returns it.

Template Parameters
ValueTypeOperatorThe datatype (float, double, complex<double>, etc.) for the underlying preconditioner
ValueTypeOperandThe datatype (float, double, complex<double>, etc.) of the vector, matrices, etc. on which the preconditioner will act.
memorySpaceThe meory sapce (HOST, DEVICE, HOST_PINNES, etc.) in which the data of the preconditioner and its operands reside

Member Typedef Documentation

◆ ValueTypeUnion

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>
using dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >::ValueTypeUnion = blasLapack::scalar_type<ValueTypeOperator, ValueTypeOperand>

Constructor & Destructor Documentation

◆ PreconditionerNone()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>
dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >::PreconditionerNone

Constructor.

◆ ~PreconditionerNone()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>
dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >::~PreconditionerNone ( )
default

Default Destructor.

Member Function Documentation

◆ apply()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>
void dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >::apply ( MultiVector< ValueTypeOperand, memorySpace > &  X,
MultiVector< ValueTypeUnion, memorySpace > &  Y 
) const
overridevirtual

◆ getPreconditionerType()

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>
PreconditionerType dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >::getPreconditionerType
overridevirtual

Member Data Documentation

◆ d_pcType

template<typename ValueTypeOperator , typename ValueTypeOperand , utils::MemorySpace memorySpace>
PreconditionerType dftefe::linearAlgebra::PreconditionerNone< ValueTypeOperator, ValueTypeOperand, memorySpace >::d_pcType
private

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