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

#include <MueLuPreconditioner.h>

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

Public Types

typedef amr::Preconditioner Preconditioner
typedef amr::scalar_t scalar_t
typedef amr::local_ordinal_t lo_t
typedef amr::global_ordinal_t go_t
typedef amr::AmrBox_t AmrBox_t
typedef MueLu::TpetraOperator< scalar_t, lo_t, go_t, amr::node_t > precond_t
typedef amr::AmrIntVect_t AmrIntVect_t
typedef std::map< std::string, Preconditioner > map_t
typedef amr::operator_t operator_t

Public Member Functions

 MueLuPreconditioner (const std::string &reuse)
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)
static std::string convertToMueLuReuseOption (const std::string &reuse)

Private Member Functions

void init_m (const std::string &reuse)

Private Attributes

Teuchos::ParameterList params_m
Teuchos::RCP< precond_t > prec_mp

Detailed Description

template<class Level>
class MueLuPreconditioner< Level >

Definition at line 32 of file MueLuPreconditioner.h.

Member Typedef Documentation

◆ AmrBox_t

template<class Level>
typedef amr::AmrBox_t MueLuPreconditioner< Level >::AmrBox_t

Definition at line 40 of file MueLuPreconditioner.h.

◆ AmrIntVect_t

template<class Level>
typedef amr::AmrIntVect_t MueLuPreconditioner< Level >::AmrIntVect_t

Definition at line 49 of file MueLuPreconditioner.h.

◆ go_t

template<class Level>
typedef amr::global_ordinal_t MueLuPreconditioner< Level >::go_t

Definition at line 39 of file MueLuPreconditioner.h.

◆ lo_t

template<class Level>
typedef amr::local_ordinal_t MueLuPreconditioner< Level >::lo_t

Definition at line 38 of file MueLuPreconditioner.h.

◆ map_t

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

Definition at line 51 of file MueLuPreconditioner.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 MueLu::TpetraOperator< scalar_t, lo_t, go_t, amr::node_t > MueLuPreconditioner< Level >::precond_t

Definition at line 47 of file MueLuPreconditioner.h.

◆ Preconditioner

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

Definition at line 35 of file MueLuPreconditioner.h.

◆ scalar_t

template<class Level>
typedef amr::scalar_t MueLuPreconditioner< Level >::scalar_t

Definition at line 37 of file MueLuPreconditioner.h.

Constructor & Destructor Documentation

◆ MueLuPreconditioner()

template<class Level>
MueLuPreconditioner< Level >::MueLuPreconditioner ( const std::string & reuse)
explicit

Definition at line 27 of file MueLuPreconditioner.hpp.

References init_m(), and prec_mp.

Here is the call graph for this function:

Member Function Documentation

◆ convertToMueLuReuseOption()

template<class Level>
std::string MueLuPreconditioner< Level >::convertToMueLuReuseOption ( const std::string & reuse)
static

Definition at line 58 of file MueLuPreconditioner.hpp.

◆ create()

template<class Level>
void MueLuPreconditioner< 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 35 of file MueLuPreconditioner.hpp.

References params_m, and prec_mp.

◆ fillMap()

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

Definition at line 51 of file MueLuPreconditioner.hpp.

◆ get()

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

Implements AmrPreconditioner< amr::matrix_t, Level >.

Definition at line 45 of file MueLuPreconditioner.hpp.

References prec_mp.

◆ init_m()

template<class Level>
void MueLuPreconditioner< Level >::init_m ( const std::string & reuse)
private

Definition at line 78 of file MueLuPreconditioner.hpp.

References params_m.

Referenced by MueLuPreconditioner().

Member Data Documentation

◆ params_m

template<class Level>
Teuchos::ParameterList MueLuPreconditioner< Level >::params_m
private

Definition at line 68 of file MueLuPreconditioner.h.

Referenced by create(), and init_m().

◆ prec_mp

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

Definition at line 69 of file MueLuPreconditioner.h.

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

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