SG++-Doxygen-Documentation
sgpp::combigrid::AbstractLevelEvaluator Class Referenceabstract

This class abstracts a lot of methods of CombigridEvaluator for classes that do not want to carry around its template parameter, e. More...

#include <AbstractLevelEvaluator.hpp>

Inheritance diagram for sgpp::combigrid::AbstractLevelEvaluator:
sgpp::combigrid::CombigridEvaluator< V >

Public Member Functions

virtual bool addLevel (MultiIndex const &level)=0
 
virtual void clear ()=0
 
virtual bool containsLevel (MultiIndex const &level)=0
 
virtual std::vector< base::DataVectorgetAllGridPoints ()=0
 
virtual double getDifferenceNorm (MultiIndex const &level)=0
 
virtual base::DataMatrix getGridPointMatrix ()=0
 
virtual std::shared_ptr< TreeStorage< uint8_t > > getLevelStructure ()=0
 
virtual std::vector< ThreadPool::TaskgetLevelTasks (MultiIndex const &level, ThreadPool::Task callback)=0
 
virtual size_t getUpperPointBound () const =0
 
virtual size_t maxNewPoints (MultiIndex const &level)=0
 
virtual size_t maxNumPointsForRegular (size_t q)=0
 
virtual size_t numDims () const =0
 
virtual size_t numPoints (MultiIndex const &level)=0
 
virtual void setMutex (std::shared_ptr< std::recursive_mutex > mutexPtr)=0
 
virtual ~AbstractLevelEvaluator ()
 

Detailed Description

This class abstracts a lot of methods of CombigridEvaluator for classes that do not want to carry around its template parameter, e.

g. LevelManager. AbstractLevelEvaluator provides the central method addLevel() that does an evaluation on a given level to make its numerical approximation more accurate.

For function descriptions, refer to CombigridEvaluator();

Constructor & Destructor Documentation

◆ ~AbstractLevelEvaluator()

sgpp::combigrid::AbstractLevelEvaluator::~AbstractLevelEvaluator ( )
virtual

Member Function Documentation

◆ addLevel()

virtual bool sgpp::combigrid::AbstractLevelEvaluator::addLevel ( MultiIndex const &  level)
pure virtual

◆ clear()

virtual void sgpp::combigrid::AbstractLevelEvaluator::clear ( )
pure virtual

◆ containsLevel()

virtual bool sgpp::combigrid::AbstractLevelEvaluator::containsLevel ( MultiIndex const &  level)
pure virtual

◆ getAllGridPoints()

virtual std::vector<base::DataVector> sgpp::combigrid::AbstractLevelEvaluator::getAllGridPoints ( )
pure virtual

◆ getDifferenceNorm()

virtual double sgpp::combigrid::AbstractLevelEvaluator::getDifferenceNorm ( MultiIndex const &  level)
pure virtual

◆ getGridPointMatrix()

virtual base::DataMatrix sgpp::combigrid::AbstractLevelEvaluator::getGridPointMatrix ( )
pure virtual

◆ getLevelStructure()

virtual std::shared_ptr<TreeStorage<uint8_t> > sgpp::combigrid::AbstractLevelEvaluator::getLevelStructure ( )
pure virtual

◆ getLevelTasks()

virtual std::vector<ThreadPool::Task> sgpp::combigrid::AbstractLevelEvaluator::getLevelTasks ( MultiIndex const &  level,
ThreadPool::Task  callback 
)
pure virtual

◆ getUpperPointBound()

virtual size_t sgpp::combigrid::AbstractLevelEvaluator::getUpperPointBound ( ) const
pure virtual
Returns
An upper bound for the number of points (function evaluations) used for the current computation. This bound is exact if nesting is used or if otherwise each grid point only occurs in exactly one level.

Implemented in sgpp::combigrid::CombigridEvaluator< V >.

◆ maxNewPoints()

virtual size_t sgpp::combigrid::AbstractLevelEvaluator::maxNewPoints ( MultiIndex const &  level)
pure virtual

◆ maxNumPointsForRegular()

virtual size_t sgpp::combigrid::AbstractLevelEvaluator::maxNumPointsForRegular ( size_t  q)
pure virtual

◆ numDims()

virtual size_t sgpp::combigrid::AbstractLevelEvaluator::numDims ( ) const
pure virtual

◆ numPoints()

virtual size_t sgpp::combigrid::AbstractLevelEvaluator::numPoints ( MultiIndex const &  level)
pure virtual

◆ setMutex()

virtual void sgpp::combigrid::AbstractLevelEvaluator::setMutex ( std::shared_ptr< std::recursive_mutex >  mutexPtr)
pure virtual

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