#include <monolish_equation.hpp>
Inheritance diagram for monolish::equation::Jacobi< MATRIX, Float >:
Collaboration diagram for monolish::equation::Jacobi< MATRIX, Float >:
Public Member Functions | |
| void | apply_precond (const vector< Float > &r, vector< Float > &z) |
| void | create_precond (MATRIX &A) |
| std::string | name () const |
| get solver name "monolish::equation::Jacobi" More... | |
| int | solve (MATRIX &A, vector< Float > &x, vector< Float > &b) |
| solve Ax = b by jacobi method(lib=0: monolish) More... | |
 Public Member Functions inherited from monolish::solver::solver< MATRIX, Float > | |
| initvec_scheme | get_initvec_scheme () const |
| get handling scheme of initial vector handling More... | |
| int | get_lib () const |
| get library option More... | |
| size_t | get_maxiter () const |
| get maxiter More... | |
| size_t | get_miniter () const |
| get miniter More... | |
| bool | get_print_rhistory () const |
| get print rhistory status More... | |
| size_t | get_residual_method () const |
| get residual method(default=0) More... | |
| double | get_tol () const |
| get tolerance More... | |
| template<class PRECOND > | |
| void | set_apply_precond (PRECOND &p) |
| set precondition apply fucntion More... | |
| template<class PRECOND > | |
| void | set_create_precond (PRECOND &p) |
| set precondition create fucntion More... | |
| void | set_initvec_scheme (initvec_scheme scheme) |
| set how to handle initial vector More... | |
| void | set_lib (int l) |
| set library option (to change library, monolish, cusolver, etc.) More... | |
| void | set_maxiter (size_t max) |
| set max iter. (default = SIZE_MAX) More... | |
| void | set_miniter (size_t min) |
| set min iter. (default = 0) More... | |
| void | set_print_rhistory (bool flag) |
| print rhistory to standart out true/false. (default = false) More... | |
| void | set_residual_method (size_t r) |
| set residual method (default=0) More... | |
| void | set_rhistory_filename (std::string file) |
| rhistory filename More... | |
| void | set_tol (double t) |
| set tolerance (default:1.0e-8) More... | |
| solver () | |
| create solver class More... | |
| ~solver () | |
| delete solver class More... | |
Private Member Functions | |
| int | monolish_Jacobi (MATRIX &A, vector< Float > &x, vector< Float > &b) |
Additional Inherited Members | |
| Protected Member Functions inherited from monolish::solver::solver< MATRIX, Float > | |
| Float | get_residual (vector< Float > &x) |
| Protected Attributes inherited from monolish::solver::solver< MATRIX, Float > | |
| initvec_scheme | initvecscheme = initvec_scheme::RANDOM |
| int | lib = 0 |
| size_t | maxiter = SIZE_MAX |
| size_t | miniter = 0 |
| precondition< MATRIX, Float > | precond |
| bool | print_rhistory = false |
| size_t | resid_method = 0 |
| std::string | rhistory_file |
| std::ostream * | rhistory_stream |
| double | tol = 1.0e-8 |
Detailed Description
template<typename MATRIX, typename Float>
class monolish::equation::Jacobi< MATRIX, Float >
Jacobi solver class.
- Note
- attribute:
- solver : true
- preconditioner : true
-
input / archtecture
- Dense / Intel : true
- Dense / NVIDIA : true
- Dense / OSS : true
- Sparse / Intel : true
- Sparse / NVIDIA : true
- Sparse / OSS : true
Definition at line 159 of file monolish_equation.hpp.
Member Function Documentation
◆ apply_precond()
template<typename MATRIX , typename Float >
| template void monolish::equation::Jacobi< MATRIX, Float >::apply_precond | ( | const vector< Float > & | r, |
| vector< Float > & | z | ||
| ) |
◆ create_precond()
template<typename MATRIX , typename T >
| template void monolish::equation::Jacobi< MATRIX, Float >::create_precond | ( | MATRIX & | A | ) |
◆ monolish_Jacobi()
template<typename MATRIX , typename Float >
|
private |
◆ name()
template<typename MATRIX , typename Float >
|
inline |
get solver name "monolish::equation::Jacobi"
- Note
- # of computation: 1
- Multi-threading: false
- GPU acceleration: false
Definition at line 182 of file monolish_equation.hpp.
◆ solve()
template<typename MATRIX , typename Float >
| template int monolish::equation::Jacobi< MATRIX, Float >::solve | ( | MATRIX & | A, |
| vector< Float > & | x, | ||
| vector< Float > & | b | ||
| ) |
solve Ax = b by jacobi method(lib=0: monolish)
- Parameters
-
[in] A CRS format Matrix [in] x solution vector [in] b right hand vector
- Returns
- error code (only 0 now)
Definition at line 137 of file jacobi.cpp.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
