My Project
Loading...
Searching...
No Matches
Opm::cuistl::CuSeqILU0< M, X, Y, l > Class Template Reference

Sequential ILU0 preconditioner on the GPU through the CuSparse library. More...

#include <CuSeqILU0.hpp>

Inheritance diagram for Opm::cuistl::CuSeqILU0< M, X, Y, l >:
Dune::PreconditionerWithUpdate< X, Y >

Public Types

using matrix_type = typename std::remove_const< M >::type
 The matrix type the preconditioner is for.
 
using domain_type = X
 The domain type of the preconditioner.
 
using range_type = Y
 The range type of the preconditioner.
 
using field_type = typename X::field_type
 The field type of the preconditioner.
 

Public Member Functions

 CuSeqILU0 (const M &A, field_type w)
 Constructor.
 
virtual void pre (X &x, Y &b) override
 Prepare the preconditioner.
 
virtual void apply (X &v, const Y &d) override
 Apply the preconditoner.
 
virtual void post (X &x) override
 Post processing.
 
virtual Dune::SolverCategory::Category category () const override
 Category of the preconditioner (see SolverCategory::Category)
 
virtual void update () override
 Updates the matrix data.
 

Static Public Member Functions

static constexpr bool shouldCallPre ()
 
static constexpr bool shouldCallPost ()
 

Detailed Description

template<class M, class X, class Y, int l = 1>
class Opm::cuistl::CuSeqILU0< M, X, Y, l >

Sequential ILU0 preconditioner on the GPU through the CuSparse library.

This implementation calls the CuSparse functions, which in turn essentially does a level decomposition to get some parallelism.

Note
This is not expected to be a fast preconditioner.
Template Parameters
MThe matrix type to operate on
XType of the update
YType of the defect
lIgnored. Just there to have the same number of template arguments as other preconditioners.
Note
We assume X and Y are both CuVector<real_type>, but we leave them as template arguments in case of future additions.

Constructor & Destructor Documentation

◆ CuSeqILU0()

template<class M , class X , class Y , int l>
Opm::cuistl::CuSeqILU0< M, X, Y, l >::CuSeqILU0 ( const M &  A,
field_type  w 
)

Constructor.

Constructor gets all parameters to operate the prec.

Parameters
AThe matrix to operate on.
wThe relaxation factor.

Member Function Documentation

◆ post()

template<class M , class X , class Y , int l>
void Opm::cuistl::CuSeqILU0< M, X, Y, l >::post ( X &  x)
overridevirtual

Post processing.

Note
Does nothing at the moment

◆ pre()

template<class M , class X , class Y , int l>
void Opm::cuistl::CuSeqILU0< M, X, Y, l >::pre ( X &  x,
Y &  b 
)
overridevirtual

Prepare the preconditioner.

Note
Does nothing at the time being.

◆ shouldCallPost()

template<class M , class X , class Y , int l = 1>
static constexpr bool Opm::cuistl::CuSeqILU0< M, X, Y, l >::shouldCallPost ( )
inlinestaticconstexpr
Returns
false

◆ shouldCallPre()

template<class M , class X , class Y , int l = 1>
static constexpr bool Opm::cuistl::CuSeqILU0< M, X, Y, l >::shouldCallPre ( )
inlinestaticconstexpr
Returns
false

◆ update()

template<class M , class X , class Y , int l>
void Opm::cuistl::CuSeqILU0< M, X, Y, l >::update ( )
overridevirtual

Updates the matrix data.

Implements Dune::PreconditionerWithUpdate< X, Y >.


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