AMG::Jacobi< EleType > Class Template Reference

Dense Jacobi iterative method. More...

#include <smoother.hpp>

Inheritance diagram for AMG::Jacobi< EleType >:

Public Member Functions
	Jacobi ()
void	smooth (const Eigen::SparseMatrix< EleType > &A, Eigen::Matrix< EleType, -1, 1 > &u, const Eigen::Matrix< EleType, -1, 1 > &b)
	Update initial guess u inplace using Jacobi method.
Public Member Functions inherited from AMG::SmootherBase< EleType >
	SmootherBase ()
	SmootherBase (size_t n_iters_)
	SmootherBase (double tolerance_, size_t compute_error_every_n_iters_, size_t n_iters_)
	Construct a new Smoother Base object with iterative solver member data.

Additional Inherited Members
Public Attributes inherited from AMG::SmootherBase< EleType >
EleType	tolerance {1e-9}
	Tolerance below which a smoother is considered to have converged.
size_t	compute_error_every_n_iters {100}
	Compute the error every n iterations during smoothing.
size_t	n_iters {1}
	Maximum number of iterations before smoothing termination.

Detailed Description

template<class EleType>
class AMG::Jacobi< EleType >

Dense Jacobi iterative method.

Template Parameters

EleType

Constructor & Destructor Documentation

Jacobi()

template<class EleType >

AMG::Jacobi< EleType >::Jacobi ( )

inline

Member Function Documentation

smooth()

template<class EleType >

void AMG::Jacobi< EleType >::smooth ( const Eigen::SparseMatrix< EleType > & A, Eigen::Matrix< EleType, -1, 1 > & u, const Eigen::Matrix< EleType, -1, 1 > & b )

inlinevirtual

Update initial guess u inplace using Jacobi method.

References:

[1] : Heath, M.T. Scientific Computing. pp 468. SIAM 2018.

Implements AMG::SmootherBase< EleType >.

---

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

• include/amg/smoother.hpp