celes_solver Class Reference

Solver settings for the master equation . More...

Public Member Functions
function	run (in obj, in mmm, in rhs, in varargin)
	Run the solver. More...

Public Attributes
Property	type
	solver type, at the moment 'BiCGStab' and 'GMRES' implemented More...
Property	tolerance
	solution tolerance. solver stops when relative error smaller More...
Property	maxIter
	maximal number of iterations. solver stops if exceeded More...
Property	restart
	for type='GMRES': restart parameter More...
Property	preconditioner
	celes_preconditioner object for faster convergency of solver More...

Detailed Description

Solver settings for the master equation .

Member Function Documentation

run()

function run	(	in	obj,
		in	mmm,
		in	rhs,
		in	varargin
	)

Run the solver.

Parameters

mmm	(function handle): master matrix multiply operator M*
rhs	(float array): right hand side of linear system
Optional	y0 (float array): initial guess for solution vector
Optional	verbose (logical): If true (default), display detailed timing information

Returns

y = M, an approximation to the solution of the linear system

Member Data Documentation

maxIter

Property maxIter

maximal number of iterations. solver stops if exceeded

preconditioner

Property preconditioner

celes_preconditioner object for faster convergency of solver

restart

Property restart

for type='GMRES': restart parameter

tolerance

Property tolerance

solution tolerance. solver stops when relative error smaller

type

Property type

solver type, at the moment 'BiCGStab' and 'GMRES' implemented

---

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

• src/classes/celes_solver.m