OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Ifpack2Preconditioner< Level > Class Template Reference

#include <Ifpack2Preconditioner.h>

Inheritance diagram for Ifpack2Preconditioner< Level >:
Collaboration diagram for Ifpack2Preconditioner< Level >:

Public Types

typedef amr::Preconditioner Preconditioner
typedef Ifpack2::Preconditioner< amr::scalar_t, amr::local_ordinal_t, amr::global_ordinal_t, amr::node_t > precond_t
typedef std::map< std::string, Preconditioner > map_t
typedef amr::operator_t operator_t

Public Member Functions

 Ifpack2Preconditioner (Preconditioner prec)
void create (const Teuchos::RCP< amr::matrix_t > &A, Level *level_p=nullptr)
Teuchos::RCP< amr::operator_t> get ()

Static Public Member Functions

static void fillMap (map_t &map)

Private Member Functions

void init_m (Preconditioner prec)

Private Attributes

std::string prectype_m
 preconditioner type
Teuchos::RCP< Teuchos::ParameterList > params_mp
 parameter list of preconditioner
Teuchos::RCP< precond_t > prec_mp

Detailed Description

template<class Level>
class Ifpack2Preconditioner< Level >

Definition at line 29 of file Ifpack2Preconditioner.h.

Member Typedef Documentation

◆ map_t

template<class Level>
typedef std::map<std::string, Preconditioner> Ifpack2Preconditioner< Level >::map_t

Definition at line 40 of file Ifpack2Preconditioner.h.

◆ operator_t

typedef amr::operator_t AmrPreconditioner< amr::matrix_t, Level >::operator_t
inherited

Definition at line 44 of file AmrPreconditioner.h.

◆ precond_t

template<class Level>
typedef Ifpack2::Preconditioner< amr::scalar_t, amr::local_ordinal_t, amr::global_ordinal_t, amr::node_t > Ifpack2Preconditioner< Level >::precond_t

Definition at line 38 of file Ifpack2Preconditioner.h.

◆ Preconditioner

template<class Level>
typedef amr::Preconditioner Ifpack2Preconditioner< Level >::Preconditioner

Definition at line 32 of file Ifpack2Preconditioner.h.

Constructor & Destructor Documentation

◆ Ifpack2Preconditioner()

template<class Level>
Ifpack2Preconditioner< Level >::Ifpack2Preconditioner ( Preconditioner prec)

Definition at line 24 of file Ifpack2Preconditioner.hpp.

References init_m(), and prec_mp.

Here is the call graph for this function:

Member Function Documentation

◆ create()

template<class Level>
void Ifpack2Preconditioner< Level >::create ( const Teuchos::RCP< amr::matrix_t > & A,
Level * level_p = nullptr )
virtual

Instantiate the preconditioner matrix

Parameters
Amatrix for which to create preconditioner
level_pbottom level if necessary to build preconditioner

Implements AmrPreconditioner< amr::matrix_t, Level >.

Definition at line 32 of file Ifpack2Preconditioner.hpp.

References params_mp, prec_mp, and prectype_m.

◆ fillMap()

template<class Level>
void Ifpack2Preconditioner< Level >::fillMap ( map_t & map)
static

Definition at line 51 of file Ifpack2Preconditioner.hpp.

◆ get()

template<class Level>
Teuchos::RCP< amr::operator_t> Ifpack2Preconditioner< Level >::get ( )
virtual
Returns
the preconditioner

Implements AmrPreconditioner< amr::matrix_t, Level >.

Definition at line 45 of file Ifpack2Preconditioner.hpp.

References prec_mp.

◆ init_m()

template<class Level>
void Ifpack2Preconditioner< Level >::init_m ( Preconditioner prec)
private

Initialize preconditioner parameter list

Definition at line 63 of file Ifpack2Preconditioner.hpp.

References params_mp, and prectype_m.

Referenced by Ifpack2Preconditioner().

Member Data Documentation

◆ params_mp

template<class Level>
Teuchos::RCP<Teuchos::ParameterList> Ifpack2Preconditioner< Level >::params_mp
private

parameter list of preconditioner

Definition at line 63 of file Ifpack2Preconditioner.h.

Referenced by create(), and init_m().

◆ prec_mp

template<class Level>
Teuchos::RCP<precond_t> Ifpack2Preconditioner< Level >::prec_mp
private

Definition at line 65 of file Ifpack2Preconditioner.h.

Referenced by create(), get(), and Ifpack2Preconditioner().

◆ prectype_m

template<class Level>
std::string Ifpack2Preconditioner< Level >::prectype_m
private

preconditioner type

Definition at line 60 of file Ifpack2Preconditioner.h.

Referenced by create(), and init_m().

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