SG++-Doxygen-Documentation
sgpp::base::OperationStencilHierarchisationModLinear Class Reference

Hierarchisation on sparse grid, linear grid with modified basis functions. More...

#include <OperationStencilHierarchisationModLinear.hpp>

Inheritance diagram for sgpp::base::OperationStencilHierarchisationModLinear:
sgpp::base::OperationStencilHierarchisation sgpp::base::OperationHierarchisation

Public Member Functions

void doDehierarchisation (DataVector &alpha) override
 Implements the dehierarchisation on a sparse grid The results are queried via get{Surplus,Neighbor,Weight}Stencil(). More...
 
void doHierarchisation (DataVector &node_values) override
 Implements the abstract hierarchisation on a sparse grid. More...
 
const IndexStencilgetNeighborStencil () const override
 Access to the results of the hierarchisation operation. More...
 
size_t getStencilSize () const override
 The number of operations performed, i.e. More...
 
const IndexStencilgetSurplusStencil () const override
 Access to the results of the hierarchisation operation. More...
 
const WeightStencilgetWeightStencil () const override
 Access to the results of the hierarchisation operation. More...
 
 OperationStencilHierarchisationModLinear (GridStorage &storage)
 Constructor of OperationStencilHierarchisationModLinear. More...
 
 ~OperationStencilHierarchisationModLinear () override
 Destructor. More...
 
- Public Member Functions inherited from sgpp::base::OperationStencilHierarchisation
 OperationStencilHierarchisation ()
 Constructor. More...
 
 ~OperationStencilHierarchisation () override
 Destructor. More...
 
- Public Member Functions inherited from sgpp::base::OperationHierarchisation
 OperationHierarchisation ()
 Constructor. More...
 
virtual ~OperationHierarchisation ()
 Destructor. More...
 

Protected Attributes

IndexStencil neighborStencil
 Index array with neighboring surplus indices. More...
 
GridStoragestorage
 reference to the grid's GridStorage object More...
 
IndexStencil surplusStencil
 Index array with surplus indices. More...
 
WeightStencil weightStencil
 Index array with surplus indices. More...
 

Additional Inherited Members

- Public Types inherited from sgpp::base::OperationStencilHierarchisation
typedef std::vector< unsigned int > IndexStencil
 
typedef std::vector< float > WeightStencil
 

Detailed Description

Hierarchisation on sparse grid, linear grid with modified basis functions.

Constructor & Destructor Documentation

◆ OperationStencilHierarchisationModLinear()

sgpp::base::OperationStencilHierarchisationModLinear::OperationStencilHierarchisationModLinear ( GridStorage storage)
inlineexplicit

Constructor of OperationStencilHierarchisationModLinear.

Parameters
storagePointer to the grid's gridstorage obejct

◆ ~OperationStencilHierarchisationModLinear()

sgpp::base::OperationStencilHierarchisationModLinear::~OperationStencilHierarchisationModLinear ( )
inlineoverride

Destructor.

References alpha, doDehierarchisation(), and doHierarchisation().

Member Function Documentation

◆ doDehierarchisation()

void sgpp::base::OperationStencilHierarchisationModLinear::doDehierarchisation ( DataVector alpha)
overridevirtual

Implements the dehierarchisation on a sparse grid The results are queried via get{Surplus,Neighbor,Weight}Stencil().

Parameters
alphadummy array

Implements sgpp::base::OperationStencilHierarchisation.

References sgpp::base::HashGridStorage::getDimension(), python.statsfileInfo::i, neighborStencil, create_scripts::s, storage, surplusStencil, sgpp::base::sweep< FUNC >::sweep1D(), and weightStencil.

Referenced by ~OperationStencilHierarchisationModLinear().

◆ doHierarchisation()

void sgpp::base::OperationStencilHierarchisationModLinear::doHierarchisation ( DataVector node_values)
overridevirtual

Implements the abstract hierarchisation on a sparse grid.

The results are queried via get{Surpluses,Neighbors,Weights}.

Parameters
node_valuesdummy array

Implements sgpp::base::OperationStencilHierarchisation.

References sgpp::base::HashGridStorage::getDimension(), python.statsfileInfo::i, neighborStencil, create_scripts::s, storage, surplusStencil, sgpp::base::sweep< FUNC >::sweep1D(), and weightStencil.

Referenced by ~OperationStencilHierarchisationModLinear().

◆ getNeighborStencil()

const IndexStencil& sgpp::base::OperationStencilHierarchisationModLinear::getNeighborStencil ( ) const
inlineoverridevirtual

Access to the results of the hierarchisation operation.

This is an index array whose contents refer to the indices associated with the grid points by means of the storage scheme used.

Returns
the neighbors array

Implements sgpp::base::OperationStencilHierarchisation.

References neighborStencil.

◆ getStencilSize()

size_t sgpp::base::OperationStencilHierarchisationModLinear::getStencilSize ( ) const
inlineoverridevirtual

The number of operations performed, i.e.

the length of each of the three arrays.

Returns
the total number of operations

Implements sgpp::base::OperationStencilHierarchisation.

References surplusStencil.

◆ getSurplusStencil()

const IndexStencil& sgpp::base::OperationStencilHierarchisationModLinear::getSurplusStencil ( ) const
inlineoverridevirtual

Access to the results of the hierarchisation operation.

This is an index array whose contents refer to the indices associated with the grid points by means of the storage scheme used.

Returns
the surpluses array

Implements sgpp::base::OperationStencilHierarchisation.

References surplusStencil.

◆ getWeightStencil()

const WeightStencil& sgpp::base::OperationStencilHierarchisationModLinear::getWeightStencil ( ) const
inlineoverridevirtual

Access to the results of the hierarchisation operation.

Returns
the weights array

Implements sgpp::base::OperationStencilHierarchisation.

References weightStencil.

Member Data Documentation

◆ neighborStencil

IndexStencil sgpp::base::OperationStencilHierarchisationModLinear::neighborStencil
protected

Index array with neighboring surplus indices.

Referenced by doDehierarchisation(), doHierarchisation(), and getNeighborStencil().

◆ storage

GridStorage& sgpp::base::OperationStencilHierarchisationModLinear::storage
protected

reference to the grid's GridStorage object

Referenced by doDehierarchisation(), and doHierarchisation().

◆ surplusStencil

IndexStencil sgpp::base::OperationStencilHierarchisationModLinear::surplusStencil
protected

Index array with surplus indices.

Referenced by doDehierarchisation(), doHierarchisation(), getStencilSize(), and getSurplusStencil().

◆ weightStencil

WeightStencil sgpp::base::OperationStencilHierarchisationModLinear::weightStencil
protected

Index array with surplus indices.

Referenced by doDehierarchisation(), doHierarchisation(), and getWeightStencil().


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