SG++
sgpp::base::RefinementFunctor Class Referenceabstract

Abstract class that defines the interface that refinement functors have to provide. More...

#include <RefinementFunctor.hpp>

Inheritance diagram for sgpp::base::RefinementFunctor:

## Public Types

typedef double value_type

## Public Member Functions

virtual size_t getRefinementsNum () const
Returns the maximal number of points that should be refined. More...

virtual double getRefinementThreshold () const =0
Returns the threshold for refinement. More...

virtual double getTotalRefinementValue (GridStorage &storage) const
Returns the total sum of local (error) indicators used for refinement. More...

virtual double operator() (GridStorage &storage, size_t seq) const =0
This should be returning a refinement value for every grid point. More...

RefinementFunctor ()
Constructor. More...

virtual double start () const =0
Returns the lower bound of refinement criterion (e.g., alpha or error) (lower bound). More...

virtual ~RefinementFunctor ()
Destructor. More...

## Detailed Description

Abstract class that defines the interface that refinement functors have to provide.

## Member Typedef Documentation

 typedef double sgpp::base::RefinementFunctor::value_type

## Constructor & Destructor Documentation

 sgpp::base::RefinementFunctor::RefinementFunctor ( )
inline

Constructor.

 virtual sgpp::base::RefinementFunctor::~RefinementFunctor ( )
inlinevirtual

Destructor.

References operator()(), and start().

## Member Function Documentation

 virtual size_t sgpp::base::RefinementFunctor::getRefinementsNum ( ) const
inlinevirtual

Returns the maximal number of points that should be refined.

The maximal number of points to refine is set in the constructor of the implementing class.

Returns
number of points that should refined. Default value: 1.

References getRefinementThreshold().

 virtual double sgpp::base::RefinementFunctor::getRefinementThreshold ( ) const
pure virtual

Returns the threshold for refinement.

Only the grid points with absolute value of refinement criterion (e.g., alpha or error) greater or equal to this threshold will be refined.

Returns
threshold value for refinement. Default value: 0.
 virtual double sgpp::base::RefinementFunctor::getTotalRefinementValue ( GridStorage & storage ) const
inlinevirtual

Returns the total sum of local (error) indicators used for refinement.

Parameters
 storage pointer to the grids storage object
Returns
total sum of local (error) indicators used for refinement
 virtual double sgpp::base::RefinementFunctor::operator() ( GridStorage & storage, size_t seq ) const
pure virtual

This should be returning a refinement value for every grid point.

The point with the highest value will be refined first.

Parameters
 storage reference to the grids storage object seq sequence number in the coefficients array
Returns
refinement value

Referenced by getTotalRefinementValue(), and ~RefinementFunctor().

 virtual double sgpp::base::RefinementFunctor::start ( ) const
pure virtual

Returns the lower bound of refinement criterion (e.g., alpha or error) (lower bound).

The refinement value of grid points to be refined have to be larger than this value

Returns
lower bound

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