CGSolver< T > Class Template Reference

#include <CGSolver.H>

Inheritance diagram for CGSolver< T >:

Collaboration diagram for CGSolver< T >:

Public Member Functions
	CGSolver ()
virtual	~CGSolver ()
virtual void	setHomogeneous (bool a_homogeneous)
virtual void	define (LinearOp< T > *a_op, bool a_homogeneous)
virtual void	solve (T &a_phi, const T &a_rhs)
	solve the equation. More...
virtual void	setConvergenceMetrics (Real a_metric, Real a_tolerance)

Public Attributes
bool	m_homogeneous
LinearOp< T > *	m_op
int	m_imax
int	m_verbosity
Real	m_eps
Real	m_reps
Real	m_convergenceMetric
Real	m_hang
int	m_exitStatus
Real	m_small
int	m_numRestarts
int	m_normType

Detailed Description

template<class T>
class CGSolver< T >

Elliptic solver using the preconditioned conjugate gradient algorithm.

Constructor & Destructor Documentation

CGSolver()

template<class T >

CGSolver< T >::CGSolver

(

)

~CGSolver()

template<class T >

CGSolver< T >::~CGSolver ( )

virtual

References CGSolver< T >::m_op.

Member Function Documentation

define()

template<class T >

void CGSolver< T >::define ( LinearOp< T > *  a_op, bool  a_homogeneous  )

virtual

define the solver. a_op is the linear operator. a_homogeneous is whether the solver uses homogeneous boundary conditions.

References CGSolver< T >::m_homogeneous, and CGSolver< T >::m_op.

Referenced by CGSolver< T >::setHomogeneous(), and JFNKSolver::solve().

setConvergenceMetrics()

template<class T >

void CGSolver< T >::setConvergenceMetrics ( Real  a_metric, Real  a_tolerance  )

virtual

References CGSolver< T >::m_convergenceMetric, and CGSolver< T >::m_eps.

Referenced by CGSolver< T >::setHomogeneous().

setHomogeneous()

template<class T>

virtual void CGSolver< T >::setHomogeneous ( bool  a_homogeneous )

inlinevirtual

References CGSolver< T >::define(), CGSolver< T >::m_homogeneous, CGSolver< T >::setConvergenceMetrics(), and CGSolver< T >::solve().

solve()

template<class T >

void CGSolver< T >::solve ( T &  a_phi, const T &  a_rhs  )

virtual

solve the equation.

References CGSolver< T >::m_convergenceMetric, CGSolver< T >::m_eps, CGSolver< T >::m_hang, CGSolver< T >::m_homogeneous, CGSolver< T >::m_imax, CGSolver< T >::m_normType, CGSolver< T >::m_op, and CGSolver< T >::m_verbosity.

Referenced by CGSolver< T >::setHomogeneous().

Member Data Documentation

m_convergenceMetric

template<class T>

Real CGSolver< T >::m_convergenceMetric

public member data: solver convergence metric – if negative, use initial residual; if positive, then use m_convergenceMetric

Referenced by CGSolver< T >::setConvergenceMetrics(), and CGSolver< T >::solve().

m_eps

template<class T>

Real CGSolver< T >::m_eps

public member data: solver tolerance

Referenced by CGSolver< T >::setConvergenceMetrics(), CGSolver< T >::solve(), and JFNKSolver::solve().

m_exitStatus

template<class T>

int CGSolver< T >::m_exitStatus

public member data: set = -1 if solver exited for an unknown reason set = 1 if solver converged to tolerance set = 2 if rho = 0 set = 3 if max number of restarts was reached

m_hang

template<class T>

Real CGSolver< T >::m_hang

public member data: minium norm of solution should change per iterations

Referenced by CGSolver< T >::solve(), and JFNKSolver::solve().

m_homogeneous

template<class T>

bool CGSolver< T >::m_homogeneous

public member data: whether the solver is restricted to homogeneous boundary conditions

Referenced by CGSolver< T >::define(), CGSolver< T >::setHomogeneous(), and CGSolver< T >::solve().

m_imax

template<class T>

int CGSolver< T >::m_imax

public member data: maximum number of iterations

Referenced by CGSolver< T >::solve(), and JFNKSolver::solve().

m_normType

template<class T>

int CGSolver< T >::m_normType

public member data: norm to be used when evaluating convergence. 0 is max norm, 1 is L(1), 2 is L(2) and so on.

Referenced by CGSolver< T >::solve(), and JFNKSolver::solve().

m_numRestarts

template<class T>

int CGSolver< T >::m_numRestarts

public member data: number of times the algorithm can restart

Referenced by JFNKSolver::solve().

m_op

template<class T>

LinearOp<T>* CGSolver< T >::m_op

public member data: operator to solve.

Referenced by CGSolver< T >::define(), CGSolver< T >::solve(), and CGSolver< T >::~CGSolver().

m_reps

template<class T>

Real CGSolver< T >::m_reps

public member data: relative solver tolerance

m_small

template<class T>

Real CGSolver< T >::m_small

public member data: what the algorithm should consider "close to zero"

m_verbosity

template<class T>

int CGSolver< T >::m_verbosity

public member data: how much screen out put the user wants. set = 0 for no output.

Referenced by CGSolver< T >::solve(), and JFNKSolver::solve().

---

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

• CGSolver.H