sgpp::base::PeriodicGridGenerator Class Reference

GridGenerator for periodic grids with boundaries. More...

#include <PeriodicGridGenerator.hpp>

Inheritance diagram for sgpp::base::PeriodicGridGenerator:

Public Member Functions
void	cliques (size_t level, size_t clique_size) override
	Creates a sparse grid with fully connected cliques.
void	cliques (size_t level, size_t clique_size, double T) override
	Creates a sparse grid with fully connected cliques.
void	coarsen (CoarseningFunctor &func, std::vector< size_t > *removedSeq) override
	Coarsens a grid according to the settings of the CoarseningFunctor func.
void	coarsenNFirstOnly (CoarseningFunctor &func, size_t numFirstOnly, std::vector< size_t > *removedSeq, size_t minIndexConsidered) override
	Coarsens a grid according to the settings of the CoarseningFunctor func.
void	full (size_t level) override
	Creates a full grid for a certain level \( n \), i.e., \( V_n = *\bigoplus_{|\vec{l}|_\infty *\leq n} W_{\vec{l}}\).
size_t	getNumberOfRefinablePoints () override
	Returns the number of points on the grid that can be refined in the next iteration.
size_t	getNumberOfRefinablePointsToMaxLevel (size_t maxLevel) override
	Returns the number of points on the grid that can be refined in the next iteration additionally a maximum level for refinement is taken into account.
size_t	getNumberOfRemovablePoints () override
	Returns the number of points on the grid that can be removed in the next iteration.
	PeriodicGridGenerator (GridStorage &storage)
	Constructor.
void	refine (RefinementFunctor &func, std::vector< size_t > *addedPoints=nullptr) override
	Refines a grid according to the settings of the RefinementFunctor func.
void	refineMaxLevel (RefinementFunctor &func, size_t maxLevel) override
	Refines a grid according to the settings of the RefinementFunctor func.
void	regular (size_t level) override
	Creates a regular sparse grid for a certain level \( n \), i.e., \( *V_n^{(1)} = *\bigoplus_{|\vec{l}|_1 \leq n+d-1} W_{\vec{l}}\).
void	regular (size_t level, double T) override
	Creates a regular sparse grid for a certain level \( n \), i.e., \( *V_n^{(1)} = *\bigoplus_{|\vec{l}|_1 \leq n+d-1} W_{\vec{l}}\).
	~PeriodicGridGenerator () override
	Destructor.
Public Member Functions inherited from sgpp::base::GridGenerator
virtual void	anisotropicFull (std::vector< size_t > dimlevels)
	Creates an anisotropicFull Grid for certain level vector, for example [2,3,1] results in a 3x7x1 grid.
	GridGenerator ()
	Constructor.
virtual void	refineInter (RefinementFunctor &func, const std::set< std::set< size_t > > &interactions)
	Refines a grid according to the settings of the RefinementFunctor func.
virtual void	regularInter (size_t level, const std::set< std::set< size_t > > &terms, double T)
	Creates a regular sparse grid for a certain level \( n \), i.e., \( *V_n^{(1)} = *\bigoplus_{|\vec{l}|_1 \leq n+d-1} W_{\vec{l}}\).
virtual void	truncated (size_t level, size_t l_user)
	Creates a grid which doesn't contain the fullgrids with li<l_user, for any li level_t.
virtual	~GridGenerator ()
	Destructor.

Protected Attributes
GridStorage &	storage
	reference to the storage object

Detailed Description

GridGenerator for periodic grids with boundaries.

Constructor & Destructor Documentation

PeriodicGridGenerator()

sgpp::base::PeriodicGridGenerator::PeriodicGridGenerator ( GridStorage &  storage )

explicit

Constructor.

Parameters

storage

the grid's storage object

~PeriodicGridGenerator()

sgpp::base::PeriodicGridGenerator::~PeriodicGridGenerator ( )

override

Destructor.

Member Function Documentation

cliques() [1/2]

void sgpp::base::PeriodicGridGenerator::cliques ( size_t  level, size_t  clique_size  )

overridevirtual

Creates a sparse grid with fully connected cliques.

Parameters

level	Grid level
clique_size	clique size

Implements sgpp::base::GridGenerator.

References sgpp::base::HashGenerator::cliques(), level, and storage.

cliques() [2/2]

void sgpp::base::PeriodicGridGenerator::cliques ( size_t  level, size_t  clique_size, double  T = 0  )

overridevirtual

Creates a sparse grid with fully connected cliques.

Parameters

level	Grid level
clique_size	clique size
T	modifier for subgrid selection, T = 0 implies standard sparse grid. For further information see Griebel and Knapek's paper optimized tensor-product approximation spaces

Reimplemented from sgpp::base::GridGenerator.

References sgpp::base::HashGenerator::cliques(), level, and storage.

coarsen()

void sgpp::base::PeriodicGridGenerator::coarsen ( CoarseningFunctor &  func, std::vector< size_t > *  removedSeq  )

overridevirtual

Coarsens a grid according to the settings of the CoarseningFunctor func.

Parameters

func	pointer to coarsening functor
removedSeq	pointer to vector to append the seq numbers of coarsened grid points to.

Implements sgpp::base::GridGenerator.

coarsenNFirstOnly()

void sgpp::base::PeriodicGridGenerator::coarsenNFirstOnly ( CoarseningFunctor &  func, size_t  numFirstOnly, std::vector< size_t > *  removedSeq, size_t  minIndexConsidered  )

overridevirtual

Coarsens a grid according to the settings of the CoarseningFunctor func.

Only numFirstOnly first grid points are checked for coarsening.

Parameters

func	pointer to coarsening functor
numFirstOnly	max. number grid points to be coarsened
removedSeq	pointer to vector to append the seq numbers of coarsened grid points to.
minIndexConsidered	Minimum index of grid points that will be coarsened

Implements sgpp::base::GridGenerator.

full()

void sgpp::base::PeriodicGridGenerator::full ( size_t  level )

overridevirtual

Creates a full grid for a certain level \( n \), i.e., \( V_n = *\bigoplus_{|\vec{l}|_\infty *\leq n} W_{\vec{l}}\).

Parameters

level

Grid level

Implements sgpp::base::GridGenerator.

getNumberOfRefinablePoints()

size_t sgpp::base::PeriodicGridGenerator::getNumberOfRefinablePoints ( )

overridevirtual

Returns the number of points on the grid that can be refined in the next iteration.

Returns

the number of points on the grid that can be refined

Implements sgpp::base::GridGenerator.

getNumberOfRefinablePointsToMaxLevel()

size_t sgpp::base::PeriodicGridGenerator::getNumberOfRefinablePointsToMaxLevel ( size_t  maxLevel )

overridevirtual

Returns the number of points on the grid that can be refined in the next iteration additionally a maximum level for refinement is taken into account.

Parameters

maxLevel

no points on higher levels than maxLevel will be created

Returns

the number of points on the grid that can be refined

Implements sgpp::base::GridGenerator.

getNumberOfRemovablePoints()

size_t sgpp::base::PeriodicGridGenerator::getNumberOfRemovablePoints ( )

overridevirtual

Returns the number of points on the grid that can be removed in the next iteration.

Returns

the number of points on the grid that can be removed

Implements sgpp::base::GridGenerator.

refine()

void sgpp::base::PeriodicGridGenerator::refine ( RefinementFunctor &  func, std::vector< size_t > *  addedPoints = nullptr  )

overridevirtual

Refines a grid according to the settings of the RefinementFunctor func.

Parameters

func	reference to refinement functor
addedPoints	pointer to vector to add newly created grid points to

Implements sgpp::base::GridGenerator.

refineMaxLevel()

void sgpp::base::PeriodicGridGenerator::refineMaxLevel ( RefinementFunctor &  func, size_t  maxLevel  )

overridevirtual

Refines a grid according to the settings of the RefinementFunctor func.

additionally a maximum level for refinement is taken into account

Parameters

func	pointer to refinement functor
maxLevel	no points on higher levels than maxLevel will be created

Implements sgpp::base::GridGenerator.

regular() [1/2]

void sgpp::base::PeriodicGridGenerator::regular ( size_t  level )

overridevirtual

Creates a regular sparse grid for a certain level \( n \), i.e., \( *V_n^{(1)} = *\bigoplus_{|\vec{l}|_1 \leq n+d-1} W_{\vec{l}}\).

Parameters

level

Grid level

Implements sgpp::base::GridGenerator.

References level, sgpp::base::HashGenerator::regularWithPeriodicBoundaries(), and storage.

regular() [2/2]

void sgpp::base::PeriodicGridGenerator::regular ( size_t  level, double  T = 0  )

overridevirtual

Creates a regular sparse grid for a certain level \( n \), i.e., \( *V_n^{(1)} = *\bigoplus_{|\vec{l}|_1 \leq n+d-1} W_{\vec{l}}\).

If the used grid doesn't support the parameter t, t = 0 is used instead.

Parameters

level	Grid level
T	modifier for subgrid selection, T = 0 implies standard sparse grid. For further information see Griebel and Knapek's paper optimized tensor-product approximation spaces

Reimplemented from sgpp::base::GridGenerator.

References level, sgpp::base::HashGenerator::regularWithPeriodicBoundaries(), and storage.

Member Data Documentation

storage

GridStorage& sgpp::base::PeriodicGridGenerator::storage

protected

reference to the storage object

Referenced by cliques(), cliques(), regular(), and regular().

---

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

• base/src/sgpp/base/grid/generation/PeriodicGridGenerator.hpp
• base/src/sgpp/base/grid/generation/PeriodicGridGenerator.cpp