CG Class Reference

Conjugate Gradient Solver. More...

Inheritance diagram for CG:

Public Member Functions
void	add_postprocess_corr (SmartPtr< IPProcessVector > op)
bool	apply (Vector *u, const Vector *f)
	Solve A*u = f, such that u = A^{-1} f by iterating u := u + B(f - A*u), f remains constant. More...
bool	apply_return_defect (Vector *u, Vector *f)
	Solve A*u = f, such that u = A^{-1} f by iterating u := u + B(f - A*u), f := f - A*u becomes new defect. More...
bool	apply_update_defect (Vector *unnamed, Vector *unnamed)
	CG ()
	CG (SmartPtr< ILinearIterator > precond)
	CG (SmartPtr< ILinearIterator > precond, SmartPtr< IConvergenceCheck > convCheck)
SmartPtr< ILinearIterator >	clone ()
	returns a clone of the object which can be modified independently More...
std::string	config_string () const
ConstSmartPtr< IConvergenceCheck >	convergence_check () const
double	defect () const
bool	init (SmartPtr< ILinearOperator > unnamed)
const char *	name () const
double	reduction () const
void	remove_postprocess_corr (SmartPtr< IPProcessVector > op)
void	set_compute_fresh_defect_when_finished (bool unnamed)
void	set_convergence_check (SmartPtr< IConvergenceCheck > unnamed)
void	set_damp (double damp)
	set the damping to a number More...
void	set_preconditioner (SmartPtr< ILinearIterator > Preconditioner)
int	step () const

Detailed Description

Conjugate Gradient Solver.

Note

default specialization is CGCPU1

See also

ug::CG

Constructor & Destructor Documentation

CG() [1/3]

CG

(

)

CG() [2/3]

CG

(

SmartPtr< ILinearIterator >

precond

)

Parameters

[in]

precond

CG() [3/3]

CG	(	SmartPtr< ILinearIterator >	precond,
		SmartPtr< IConvergenceCheck >	convCheck
	)

Parameters

[in]	precond
[in]	convCheck

Member Function Documentation

add_postprocess_corr()

void add_postprocess_corr ( SmartPtr< IPProcessVector >  op )

inline

Parameters

[in]

op

References CG< class >::add_postprocess_corr().

apply()

bool apply ( Vector *  u, const Vector *  f  )

inlineinherited

Solve A*u = f, such that u = A^{-1} f by iterating u := u + B(f - A*u), f remains constant.

Parameters

[in]	u
[in]	f

Returns

Success

References ILinearOperatorInverse< X, Y >::apply().

apply_return_defect()

bool apply_return_defect ( Vector *  u, Vector *  f  )

inlineinherited

Solve A*u = f, such that u = A^{-1} f by iterating u := u + B(f - A*u), f := f - A*u becomes new defect.

Parameters

[in]	u
[in]	f

Returns

Success

References ILinearOperatorInverse< X, Y >::apply_return_defect().

apply_update_defect()

bool apply_update_defect ( Vector *  unnamed, Vector *  unnamed  )

inlineinherited

Parameters

[in]	unnamed
[in]	unnamed

References ILinearIterator< X, Y >::apply_update_defect().

clone()

SmartPtr<ILinearIterator> clone ( )

inlineinherited

returns a clone of the object which can be modified independently

Returns

SmartPointer to a copy of this object

References ILinearIterator< X, Y >::clone().

config_string()

std::string config_string ( ) const

inlineinherited

References ILinearOperatorInverse< X, Y >::config_string().

convergence_check()

ConstSmartPtr<IConvergenceCheck> convergence_check ( ) const

inlineinherited

References ILinearOperatorInverse< X, Y >::convergence_check().

defect()

double defect ( ) const

inlineinherited

Returns

the current defect

References ILinearOperatorInverse< X, Y >::defect().

init()

bool init ( SmartPtr< ILinearOperator >  unnamed )

inlineinherited

Parameters

[in]

unnamed

References ILinearOperatorInverse< X, Y >::init().

name()

const char* name ( ) const

inlineinherited

References ILinearIterator< X, Y >::name().

reduction()

double reduction ( ) const

inlineinherited

Returns

the current relative reduction

References ILinearOperatorInverse< X, Y >::reduction().

remove_postprocess_corr()

void remove_postprocess_corr ( SmartPtr< IPProcessVector >  op )

inline

Parameters

[in]

op

References CG< class >::remove_postprocess_corr().

set_compute_fresh_defect_when_finished()

void set_compute_fresh_defect_when_finished ( bool  unnamed )

inlineinherited

Parameters

[in]

unnamed

References IPreconditionedLinearOperatorInverse< X >::set_compute_fresh_defect_when_finished().

set_convergence_check()

void set_convergence_check ( SmartPtr< IConvergenceCheck >  unnamed )

inlineinherited

Parameters

[in]

unnamed

References ILinearOperatorInverse< X, Y >::set_convergence_check().

set_damp()

void set_damp ( double  damp )

inlineinherited

set the damping to a number

Parameters

[in]

damp

References ILinearIterator< X, Y >::set_damp().

set_preconditioner()

void set_preconditioner ( SmartPtr< ILinearIterator >  Preconditioner )

inlineinherited

Parameters

[in]

Preconditioner

References IPreconditionedLinearOperatorInverse< X >::set_preconditioner().

step()

int step ( ) const

inlineinherited

Returns

the current number of steps

References ILinearOperatorInverse< X, Y >::step().