Kaskade::JacobiSolver< Scalar, nComponents > Class Template Reference

#include <jacobiSolver.hh>

Detailed Description

template<class Scalar, int nComponents = 1>
class Kaskade::JacobiSolver< Scalar, nComponents >

Jacobi iteration working on block matrices and vectors.

Template Parameters

nComponents

number of components in each block entry (i.e. number of components of ansatz functions)

Definition at line 19 of file jacobiSolver.hh.

Inheritance diagram for Kaskade::JacobiSolver< Scalar, nComponents >:

Public Types
typedef Dune::FieldMatrix< Scalar, nComponents, nComponents >	MatrixBlock
typedef Dune::FieldVector< Scalar, nComponents >	VectorBlock

Public Member Functions
	JacobiSolver (Dune::BCRSMatrix< MatrixBlock > const &A_, size_t maxSteps_=100, double relaxation_=1.0)
	Constructor taking a reference to a bcrs matrix. More...
virtual	~JacobiSolver ()
void	pre (Dune::BlockVector< VectorBlock > &, Dune::BlockVector< VectorBlock > &)
void	post (Dune::BlockVector< VectorBlock > &)
void	apply (Dune::BlockVector< VectorBlock > &solution, Dune::BlockVector< VectorBlock > const &rhs)

Static Public Attributes
static int const	category = Dune::SolverCategory::sequential

Member Typedef Documentation

MatrixBlock

template<class Scalar , int nComponents = 1>

typedef Dune::FieldMatrix<Scalar,nComponents,nComponents> Kaskade::JacobiSolver< Scalar, nComponents >::MatrixBlock

Definition at line 22 of file jacobiSolver.hh.

VectorBlock

template<class Scalar , int nComponents = 1>

typedef Dune::FieldVector<Scalar,nComponents> Kaskade::JacobiSolver< Scalar, nComponents >::VectorBlock

Definition at line 23 of file jacobiSolver.hh.

Constructor & Destructor Documentation

JacobiSolver()

template<class Scalar , int nComponents = 1>

Kaskade::JacobiSolver< Scalar, nComponents >::JacobiSolver ( Dune::BCRSMatrix< MatrixBlock > const &  A_, size_t  maxSteps_ = 100, double  relaxation_ = 1.0  )

inlineexplicit

Constructor taking a reference to a bcrs matrix.

@TODO: constructor taking triplet matrix or operators??? This is difficult if we want to avoid unnecessary matrix copies. On the other hand this would allow a unique interface.

Definition at line 32 of file jacobiSolver.hh.

~JacobiSolver()

template<class Scalar , int nComponents = 1>

virtual Kaskade::JacobiSolver< Scalar, nComponents >::~JacobiSolver ( )

inlinevirtual

Definition at line 38 of file jacobiSolver.hh.

Member Function Documentation

apply()

template<class Scalar , int nComponents = 1>

void Kaskade::JacobiSolver< Scalar, nComponents >::apply ( Dune::BlockVector< VectorBlock > &  solution, Dune::BlockVector< VectorBlock > const &  rhs  )

inline

Definition at line 43 of file jacobiSolver.hh.

post()

template<class Scalar , int nComponents = 1>

void Kaskade::JacobiSolver< Scalar, nComponents >::post ( Dune::BlockVector< VectorBlock > &  )

inline

Definition at line 41 of file jacobiSolver.hh.

pre()

template<class Scalar , int nComponents = 1>

void Kaskade::JacobiSolver< Scalar, nComponents >::pre ( Dune::BlockVector< VectorBlock > &  , Dune::BlockVector< VectorBlock > &    )

inline

Definition at line 40 of file jacobiSolver.hh.

Member Data Documentation

category

template<class Scalar , int nComponents = 1>

int const Kaskade::JacobiSolver< Scalar, nComponents >::category = Dune::SolverCategory::sequential

static

Definition at line 25 of file jacobiSolver.hh.

---

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

• jacobiSolver.hh