LAMA
lama::AMGSetup Class Reference

The class AMGSetup should describe the Interace to an AMG Setup. More...

#include <AMGSetup.hpp>

Inheritance diagram for lama::AMGSetup:

Public Member Functions

 AMGSetup ()
virtual ~AMGSetup ()
virtual void initialize (const Matrix &coefficients)=0
virtual SolvergetCoarseLevelSolver ()=0
virtual unsigned int getNumLevels ()=0
virtual SolvergetSmoother (const unsigned int level)=0
virtual const MatrixgetGalerkin (const unsigned int level)=0
virtual const MatrixgetRestriction (const unsigned int level)=0
virtual const MatrixgetInterpolation (const unsigned int level)=0
virtual VectorgetSolutionVector (const unsigned int level)=0
virtual VectorgetRhsVector (const unsigned int level)=0
virtual VectorgetTmpResVector (const unsigned int level)=0
virtual std::string getCouplingPredicateInfo () const =0
virtual std::string getColoringInfo () const =0
virtual std::string getInterpolationInfo () const =0
virtual std::string getSmootherInfo () const =0
virtual std::string getCoarseLevelSolverInfo () const =0
virtual void setMaxLevels (const unsigned int level)=0
virtual void setMinVarsCoarseLevel (const unsigned int vars)=0
virtual void setHostOnlyLevel (IndexType hostOnlyLevel)
virtual void setReplicatedLevel (IndexType replicatedLevel)
virtual void setCoarseLevelSolver (SolverPtr solver)=0
virtual void setSmoother (SolverPtr solver)=0
 Sets smoother for all level.

Protected Attributes

IndexType mHostOnlyLevel
IndexType mReplicatedLevel

Detailed Description

The class AMGSetup should describe the Interace to an AMG Setup.

Todo:
The current Interface of AMGSetup is just for evaluation so this should be changed to meet all requirements. (e.g. Pre and Post Smoothing)

Constructor & Destructor Documentation


Member Function Documentation

virtual Solver& lama::AMGSetup::getCoarseLevelSolver ( ) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual std::string lama::AMGSetup::getCoarseLevelSolverInfo ( ) const [pure virtual]

Implemented in lama::SingleGridSetup.

virtual std::string lama::AMGSetup::getColoringInfo ( ) const [pure virtual]

Implemented in lama::SingleGridSetup.

virtual std::string lama::AMGSetup::getCouplingPredicateInfo ( ) const [pure virtual]

Implemented in lama::SingleGridSetup.

virtual const Matrix& lama::AMGSetup::getGalerkin ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual const Matrix& lama::AMGSetup::getInterpolation ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual std::string lama::AMGSetup::getInterpolationInfo ( ) const [pure virtual]

Implemented in lama::SingleGridSetup.

virtual unsigned int lama::AMGSetup::getNumLevels ( ) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual const Matrix& lama::AMGSetup::getRestriction ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual Vector& lama::AMGSetup::getRhsVector ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual Solver& lama::AMGSetup::getSmoother ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual std::string lama::AMGSetup::getSmootherInfo ( ) const [pure virtual]

Implemented in lama::SingleGridSetup.

virtual Vector& lama::AMGSetup::getSolutionVector ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual Vector& lama::AMGSetup::getTmpResVector ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual void lama::AMGSetup::initialize ( const Matrix coefficients) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual void lama::AMGSetup::setCoarseLevelSolver ( SolverPtr  solver) [pure virtual]

Implemented in lama::SingleGridSetup.

void lama::AMGSetup::setHostOnlyLevel ( IndexType  hostOnlyLevel) [virtual]

References mHostOnlyLevel.

virtual void lama::AMGSetup::setMaxLevels ( const unsigned int  level) [pure virtual]

Implemented in lama::SingleGridSetup.

virtual void lama::AMGSetup::setMinVarsCoarseLevel ( const unsigned int  vars) [pure virtual]

Implemented in lama::SingleGridSetup.

void lama::AMGSetup::setReplicatedLevel ( IndexType  replicatedLevel) [virtual]

References mReplicatedLevel.

virtual void lama::AMGSetup::setSmoother ( SolverPtr  solver) [pure virtual]

Sets smoother for all level.

Implemented in lama::SingleGridSetup.


Field Documentation


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