CGParam Class Reference

#include <CGParam.hpp>

Public Member Functions
	CGParam (int nitermax=1000, double eps=EPSILON8)
	CGParam (const CGParam &m)
CGParam &	operator= (const CGParam &m)
virtual	~CGParam ()
void	setEps (double eps)
void	setNIterMax (int nIterMax)
void	setX0 (VectorDouble x0)
void	setPrecond (const ALinearOp *precond, int status)
void	setPrecondStatus (int precondStatus)
double	getEps () const
int	getNIterMax () const
const ALinearOp *	getPrecond () const
const VectorDouble &	getX0 () const
double	getX0 (int i) const
int	getPrecondStatus () const

Private Attributes
int	_nIterMax
double	_eps
VectorDouble	_x0
int	_precondStatus
const ALinearOp *	_precond

Constructor & Destructor Documentation

CGParam() [1/2]

CGParam::CGParam	(	int	nitermax = 1000,
		double	eps = EPSILON8
	)

CGParam() [2/2]

CGParam::CGParam

(

const CGParam &

m

)

~CGParam()

CGParam::~CGParam ( )

virtual

Member Function Documentation

getEps()

double CGParam::getEps ( ) const

inline

getNIterMax()

int CGParam::getNIterMax ( ) const

inline

getPrecond()

const ALinearOp* CGParam::getPrecond ( ) const

inline

getPrecondStatus()

int CGParam::getPrecondStatus ( ) const

inline

getX0() [1/2]

const VectorDouble& CGParam::getX0 ( ) const

inline

getX0() [2/2]

double CGParam::getX0 ( int  i ) const

inline

operator=()

CGParam & CGParam::operator=

(

const CGParam &

m

)

setEps()

void CGParam::setEps ( double  eps )

inline

setNIterMax()

void CGParam::setNIterMax ( int  nIterMax )

inline

setPrecond()

void CGParam::setPrecond	(	const ALinearOp *	precond,
		int	status
	)

Define the Pre-Conditioner facility

Parameters

[in]	precond	Pointer to a ALinearOp operator
[in]	status	Status of this Pre-conditioner 0 : not defined and therefore not used -1 : Pre-conditioner is the Q_{-1} 1 : Pre-conditioner is the Q

Remarks

When 'precond' argument is not provided, 'status' is forced to 0

setPrecondStatus()

void CGParam::setPrecondStatus ( int  precondStatus )

inline

setX0()

void CGParam::setX0 ( VectorDouble  x0 )

inline

Member Data Documentation

_eps

double CGParam::_eps

private

_nIterMax

int CGParam::_nIterMax

private

_precond

const ALinearOp* CGParam::_precond

private

_precondStatus

int CGParam::_precondStatus

private

_x0

VectorDouble CGParam::_x0

private

---

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

• include/LinearOp/CGParam.hpp
• src/LinearOp/CGParam.cpp