The class CG represents a IterativeSolver which uses the krylov subspace CG method to solve a system of linear equations iteratively. More...

#include <CG.hpp>

Inheritance diagram for lama::CG:

[legend]

Data Structures
struct	CGRuntime
Public Member Functions
	CG (const std::string &id)
	Creates a CG solver with a given ID.
	CG (const std::string &id, LoggerPtr logger)
	Create a CG solver with a given ID and a given logger.
	CG (const CG &other)
	Copy constructor that copies the status independent solver information.
virtual	~CG ()
virtual void	initialize (const Matrix &coefficients)
	Used to initialize a solver with a certain matrix A from A*u=f.
virtual SolverPtr	copy ()
	Copies the status independent solver informations to create a new instance of the same type.
virtual CGRuntime &	getRuntime ()
	Returns the complete configuration of the derived class.
virtual const CGRuntime &	getConstRuntime () const
	Returns the complete configuration of the derived class.
virtual void	solveImpl ()
	Solves the equation system.
void	setStoppingCriterion (const CriterionPtr criterion)
	set a new StoppingCriterion to the solver.
void	setPreconditioner (SolverPtr const conditioner)
	Sets the preconditioner of this solver.
const SolverPtr	getPreconditioner () const
	returns the preconditioner of this solver
int	getIterationCount () const
	returns the number of iterations, this solver has done so far.
virtual void	solve (Vector &solution, const Vector &rhs)
	Solves the equation system based on the given rhs.
virtual void	solveInit (Vector &solution, const Vector &rhs)
	Initializes the solver with rhs and solution.
virtual void	solveFinalize ()
	Finalizes the solving process.
const std::string &	getId () const
	Returns the ID of this solver.
const Vector &	getResidual () const
	Contingently calculates the current residual based on the coefficients, rhs and solution currently associated with this.
const Matrix &	getCoefficients () const
	Gets the matrix A from A*u=f.
void	setLogger (LoggerPtr logger)
	Redefines mLogger.
void	setLogLevel (LogLevel::LogLevel level)
	Switches the loglevel of mLogger.
virtual void	setContext (ContextPtr context)
	Sets the context where this solver should be executed.
Protected Member Functions
virtual void	iterate ()
	Represents one iteration step of the solver.
	LAMA_LOG_DECL_STATIC_LOGGER (logger)
bool	criteriaAreSatisfied () const
	Checks if all of the stopping criteria are satisfied.
void	logStartSolve ()
	Logging methods to maintain code-readability.
void	logEndSolve ()
void	logIterationEndAndResidual ()
void	logIterationStart ()
virtual void	writeAt (std::ostream &stream) const
	Overrides Printable::writeAt with more useful stuff.
Protected Attributes
CGRuntime	mCGRuntime
SolverPtr	mPreconditioner
	The preconditioner of this solver.
CriterionPtr	mCriterionRootComponent
	The root stopping criterion evaluated every iteration in the solve method.
std::string	mId
	The ID of this solver.
LoggerPtr	mLogger
	The solver logger.
ContextPtr	mContext
	For forcing the context solver dependent.

Detailed Description

The class CG represents a IterativeSolver which uses the krylov subspace CG method to solve a system of linear equations iteratively.

Constructor & Destructor Documentation

lama::CG::CG ( const std::string & id )

Creates a CG solver with a given ID.

Parameters:

id	The ID for the solver.

Referenced by copy().

lama::CG::CG	(	const std::string &	id,
		LoggerPtr	logger
	)

Create a CG solver with a given ID and a given logger.

Parameters:

id	The ID of the solver.
logger	The logger which shall be used by the solver

lama::CG::CG ( const CG & other )

Copy constructor that copies the status independent solver information.

lama::CG::~CG ( ) [virtual]

Member Function Documentation

SolverPtr lama::CG::copy ( ) [virtual]

Copies the status independent solver informations to create a new instance of the same type.

Returns:: shared pointer of the copied solver

Implements lama::IterativeSolver.

References CG().

bool lama::IterativeSolver::criteriaAreSatisfied ( ) const [protected, inherited]

Checks if all of the stopping criteria are satisfied.

return Whether the criteria are satisfied or not

References lama::Solver::getId(), LAMA_THROWEXCEPTION, and lama::IterativeSolver::mCriterionRootComponent.

Referenced by lama::IterativeSolver::solveImpl().

const Matrix & lama::Solver::getCoefficients ( ) const [inherited]

Gets the matrix A from A*u=f.

Returns:: The coefficient matrix A.

References lama::Solver::getConstRuntime(), LAMA_ASSERT_DEBUG, and lama::Solver::SolverRuntime::mCoefficients.

Referenced by lama::InverseSolver::invert(), and lama::LUSolver::piamax_own().

const CG::CGRuntime & lama::CG::getConstRuntime ( ) const [virtual]

Returns the complete configuration of the derived class.

Implements lama::IterativeSolver.

References mCGRuntime.

const std::string & lama::Solver::getId ( ) const [inherited]

Returns the ID of this solver.

Returns:: The ID of this solver.

References lama::Solver::mId.

Referenced by lama::IterativeSolver::criteriaAreSatisfied(), lama::IterativeSolver::solveImpl(), and lama::SolverConfigGrammar::SolverConfigGrammar().

int lama::IterativeSolver::getIterationCount ( ) const [inherited]

returns the number of iterations, this solver has done so far.

References lama::IterativeSolver::getConstRuntime(), and lama::IterativeSolver::IterativeSolverRuntime::mIterations.

Referenced by lama::IterationCount::isSatisfied(), lama::ResidualThreshold::isSatisfied(), iterate(), and lama::GMRES::iterate().

const SolverPtr lama::IterativeSolver::getPreconditioner ( ) const [inherited]

returns the preconditioner of this solver

Returns:: the preconditioner

References lama::IterativeSolver::mPreconditioner.

Referenced by lama::MetaSolver::initializePreconditioner(), and lama::IterativeSolver::IterativeSolver().

const Vector & lama::Solver::getResidual ( ) const [inherited]

Contingently calculates the current residual based on the coefficients, rhs and solution currently associated with this.

Should be used internally only, because the three vectors mentioned above have to be initialized.

Returns:: The current residual

References lama::LogLevel::completeInformation, lama::Vector::create(), lama::SolutionProxy::getConstReference(), lama::Solver::getConstRuntime(), lama::SolutionProxy::isDirty(), LAMA_ASSERT_DEBUG, lama::Solver::SolverRuntime::mCoefficients, lama::Solver::mLogger, lama::Solver::SolverRuntime::mResidual, lama::Solver::SolverRuntime::mRhs, lama::Solver::SolverRuntime::mSolution, and lama::SolutionProxy::setDirty().

Referenced by lama::ResidualStagnation::isSatisfied(), lama::ResidualThreshold::isSatisfied(), iterate(), lama::GMRES::iterate(), and lama::Logger::logResidual().

CG::CGRuntime & lama::CG::getRuntime ( ) [virtual]

Returns the complete configuration of the derived class.

Implements lama::IterativeSolver.

References mCGRuntime.

Referenced by initialize(), and iterate().

void lama::CG::initialize ( const Matrix & coefficients ) [virtual]

Used to initialize a solver with a certain matrix A from A*u=f.

This method initializes a solver with a certain coefficient-matrix. The only thing it does is storing the matrix pointer as a member for derived solver classes to use it. The caller delegates the property of the pointer to the Solver instance.

This method may be overwritten by derived classes which desire more complex initialization.

Parameters:

coefficients The matrix A from A*u=f.

Reimplemented from lama::IterativeSolver.

References lama::Scalar::DOUBLE, lama::Scalar::FLOAT, lama::Matrix::getContextPtr(), lama::Distributed::getDistributionPtr(), getRuntime(), lama::Matrix::getValueType(), LAMA_REGION, LAMA_THROWEXCEPTION, lama::CG::CGRuntime::mP, lama::CG::CGRuntime::mPScalar, lama::CG::CGRuntime::mQ, and lama::CG::CGRuntime::mZ.

void lama::CG::iterate ( ) [protected, virtual]

Represents one iteration step of the solver.

Use this abstract method to implement new iterative solvers (e.g. Jacobi)

This method represents one solver iteration. Idealically a derived iterative solver only overwrites this method. It is only used by the solve() method of this class. Use the member variables m_rhs, mSolution and m_coefficients during the iteration process.

Implements lama::IterativeSolver.

References lama::IterativeSolver::getIterationCount(), lama::Solver::getResidual(), getRuntime(), lama::Scalar::getValue(), LAMA_REGION, mCGRuntime, lama::CG::CGRuntime::mP, lama::IterativeSolver::mPreconditioner, lama::CG::CGRuntime::mPScalar, lama::CG::CGRuntime::mQ, and lama::CG::CGRuntime::mZ.

lama::CG::LAMA_LOG_DECL_STATIC_LOGGER ( logger ) [protected]

Reimplemented from lama::IterativeSolver.

void lama::IterativeSolver::logEndSolve ( ) [protected, inherited]

References lama::IterativeSolver::getRuntime(), lama::Solver::mLogger, and lama::LogLevel::solverInformation.

Referenced by lama::IterativeSolver::solveImpl().

void lama::IterativeSolver::logIterationEndAndResidual ( ) [protected, inherited]

References lama::LogLevel::advancedInformation, lama::LogLevel::convergenceHistory, lama::IterativeSolver::getRuntime(), lama::l2Norm(), lama::IterativeSolver::IterativeSolverRuntime::mIterations, and lama::Solver::mLogger.

Referenced by lama::IterativeSolver::solveImpl().

void lama::IterativeSolver::logIterationStart ( ) [protected, inherited]

References lama::LogLevel::completeInformation, lama::IterativeSolver::getRuntime(), and lama::Solver::mLogger.

Referenced by lama::IterativeSolver::solveImpl().

void lama::IterativeSolver::logStartSolve ( ) [protected, inherited]

Logging methods to maintain code-readability.

References lama::LogLevel::convergenceHistory, lama::l2Norm(), lama::Solver::mLogger, and lama::LogLevel::solverInformation.

Referenced by lama::IterativeSolver::solveImpl().

void lama::Solver::setContext ( ContextPtr context ) [virtual, inherited]

Sets the context where this solver should be executed.

Sets the context where this solver should be executed. Caution: This overrides the context of the coefficients matrix A from A * u = f used to inializ this solver.

Parameters:

[in] context the context where this solver should be executed.

Reimplemented in lama::InverseSolver.

References lama::Solver::mContext.

Referenced by lama::GMRES::initialize().

void lama::Solver::setLogger ( LoggerPtr logger ) [inherited]

Redefines mLogger.

References lama::Solver::mLogger.

void lama::Solver::setLogLevel ( LogLevel::LogLevel level ) [inherited]

Switches the loglevel of mLogger.

Returns:

References lama::Solver::mLogger.

void lama::IterativeSolver::setPreconditioner ( SolverPtr const conditioner ) [inherited]

Sets the preconditioner of this solver.

Preconditioner should be set before initializing the this solver, otherwise the preconditioner initialization should be executed manually

Parameters:

conditioner The preconditioner

References lama::IterativeSolver::mPreconditioner.

void lama::IterativeSolver::setStoppingCriterion ( const CriterionPtr criterion ) [inherited]

set a new StoppingCriterion to the solver.

Parameters:

[in] criterion the new criterion.

References LAMA_ASSERT_ERROR, and lama::IterativeSolver::mCriterionRootComponent.

Referenced by lama::SingleGridSetup::initialize().

void lama::Solver::solve	(	Vector &	solution,
		const Vector &	rhs
	)		`[virtual, inherited]`

Solves the equation system based on the given rhs.

The solver needs to be initialized first with the matrix from the equation to solve, e.g. A from A*u=f (call solver::initialize(A) for example) This method is abstract. It has to be implemented by a class which inherits from this class.

Parameters:

rhs	The right hand side of A*u=f.
solution	The solution from A*u=f. Mostly used as starting solution for an IterativeSolver.

Reimplemented in lama::LUSolver, lama::DefaultJacobi, and lama::SpecializedJacobi.

References lama::Solver::getConstRuntime(), LAMA_REGION, lama::Solver::solveFinalize(), lama::Solver::solveImpl(), and lama::Solver::solveInit().

Referenced by lama::SimpleAMG::cycle().

void lama::Solver::solveFinalize ( ) [virtual, inherited]

Finalizes the solving process.

Reimplemented in lama::DefaultJacobi, and lama::SpecializedJacobi.

Referenced by lama::Solver::solve().

void lama::IterativeSolver::solveImpl ( ) [virtual, inherited]

Solves the equation system.

Rhs and starting solution have to be initialized first! (call solveInit( rhs, solution ) ). The solver needs to be initialized first with the matrix from the equation to solve, e.g. A from A*u=f (call solver::initialize(A) for example)

This method solves the equation system by using the given rhs and solution. For most iterative solvers the solution-vector is used as a starting solution for the solve process. This class does not take responsibility for deleting the vectors after the solver! Make sure you do not delete the vectors during the solver process.

Implements lama::Solver.

References lama::IterativeSolver::criteriaAreSatisfied(), lama::IterativeSolver::getConstRuntime(), lama::Solver::getId(), lama::IterativeSolver::getRuntime(), lama::IterativeSolver::iterate(), LAMA_THROWEXCEPTION, lama::IterativeSolver::logEndSolve(), lama::IterativeSolver::logIterationEndAndResidual(), lama::IterativeSolver::logIterationStart(), lama::IterativeSolver::logStartSolve(), and lama::IterativeSolver::IterativeSolverRuntime::mIterations.