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

grid with linear base functions More...

#include <GridStencil.hpp>

Inheritance diagram for sgpp::base::GridStencil:
sgpp::base::Grid sgpp::base::LinearGridStencil sgpp::base::ModLinearGridStencil

Public Types

typedef std::vector< unsigned int > IndexStencil
 
typedef std::vector< float > WeightStencil
 

Public Member Functions

virtual const IndexStencil & getNeighborStencil () const
 Get the neighbor stencil, in fact an array of unsigned ints. More...
 
virtual const IndexStencil & getSurplusStencil () const
 Get the surplus stencil, in fact an array of unsigned ints. More...
 
virtual const WeightStencil & getWeightStencil () const
 Get the weight stencil, in fact an array of floats. More...
 
 GridStencil (size_t dim)
 Constructor Linear Grid without boundaries. More...
 
 GridStencil (BoundingBox &BB)
 Constructor Linear Grid. More...
 
 ~GridStencil () override
 Destructor. More...
 
- Public Member Functions inherited from sgpp::base::Grid
Grid * clone ()
 copies a grid More...
 
Grid * createGridOfEquivalentType (size_t numDims)
 creates an equivalent grid without copying the grid points More...
 
std::vector< size_t > getAlgorithmicDimensions ()
 returns the algorithmic dimensions (the dimensions in which the Up Down operations should be applied) More...
 
virtual SBasis & getBasis ()=0
 Returns the Basis class associated with the grid. More...
 
virtual BoundingBox & getBoundingBox ()
 gets a reference to the GridStorage's BoundingsBox object More...
 
size_t getDimension () const
 Returns the number of dimensions. More...
 
virtual GridGenerator & getGenerator ()=0
 
size_t getSize () const
 Returns the number of points on the grid. More...
 
virtual GridStorage & getStorage ()
 gets a reference to the GridStorage object More...
 
virtual Stretching & getStretching ()
 gets a reference to the GridStorage's Stretching object More...
 
virtual sgpp::base::GridType getType ()=0
 Returns a string that identifies the grid type uniquely. More...
 
std::string getTypeAsString ()
 Returns a string that identifies the grid type uniquely. More...
 
sgpp::base::GridType getZeroBoundaryType ()
 Returns the grid type that corresponds to the actual type but does no boundary treatment. More...
 
 Grid (const Grid &other)=delete
 delete copy constructor More...
 
void insertPoint (size_t dim, unsigned int levels[], unsigned int indices[], bool isLeaf)
 Insert one point to the grid. More...
 
void refine (DataVector &vector, int numOfPoints)
 Refine grid Refine the given number of points on the grid according to the vector. More...
 
void serialize (std::string &ostr, int version=SERIALIZATION_VERSION)
 Serializes grid to a string. More...
 
virtual void serialize (std::ostream &ostr, int version=SERIALIZATION_VERSION)
 Serializes the grid. More...
 
std::string serialize (int version=SERIALIZATION_VERSION)
 Serializes grid to a string. More...
 
void setAlgorithmicDimensions (std::vector< size_t > newAlgoDims)
 sets the algorithmic dimensions (the dimensions in which the Up Down operations should be applied) More...
 
virtual void setBoundingBox (BoundingBox &boundingBox)
 sets the GridStorage's BoundingsBox pointer to a BoundingBox object More...
 
virtual void setStretching (Stretching &stretching)
 sets the GridStorage's Stretching pointer to a Stretching object More...
 
virtual ~Grid ()
 Desctructor. More...
 

Protected Member Functions

 GridStencil (std::istream &istr)
 
- Protected Member Functions inherited from sgpp::base::Grid
 Grid (std::istream &istr)
 This constructor creates a new GridStorage out of the stream. More...
 
 Grid (size_t dim)
 Constructor initializing the grid storage with the given dimensionality. More...
 
 Grid (BoundingBox &boundingBox)
 Constructor initializing the grid storage with the given BoundingBox. More...
 
 Grid (Stretching &stretching)
 Constructor initializing the grid storage with the given Stretching. More...
 

Protected Attributes

IndexStencil neighborStencil
 
IndexStencil surplusStencil
 
WeightStencil weightStencil
 
- Protected Attributes inherited from sgpp::base::Grid
GridStorage storage
 GridStorage object of the grid. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sgpp::base::Grid
static Grid * createBsplineBoundaryGrid (size_t dim, size_t degree)
 creates a B-spline trapezoid boundary grid More...
 
static Grid * createBsplineClenshawCurtisGrid (size_t dim, size_t degree)
 creates a B-spline Clenshaw-Curtis grid More...
 
static Grid * createBsplineGrid (size_t dim, size_t degree)
 creates a B-spline grid More...
 
static Grid * createFundamentalSplineGrid (size_t dim, size_t degree)
 creates a fundamental spline grid More...
 
static Grid * createGrid (RegularGridConfiguration gridConfig)
 creates a grid defined by the grid configuration More...
 
static Grid * createLinearBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a linear boundary grid More...
 
static Grid * createLinearClenshawCurtisBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a linear Clenshaw-Curtis boundary grid More...
 
static Grid * createLinearClenshawCurtisGrid (size_t dim)
 creates a linear Clenshaw-Curtis grid More...
 
static Grid * createLinearGrid (size_t dim)
 Creates and returns a grid without grid points on the boundary (zero boundary conditions) with piecewise linear basis functions. More...
 
static Grid * createLinearGridStencil (size_t dim)
 creates a stencil for a linear grid (without boundaries) More...
 
static Grid * createLinearStretchedBoundaryGrid (size_t dim)
 creates a linearstretched truncated boundary grid More...
 
static Grid * createLinearStretchedGrid (size_t dim)
 creates a linear stretched grid without boundaries More...
 
static Grid * createLinearTruncatedBoundaryGrid (size_t dim)
 creates a truncated boundary grid=contains all the gridpoints of the fullgrids which have \(|l|<level and li>=l_user\) More...
 
static Grid * createModBsplineClenshawCurtisGrid (size_t dim, size_t degree)
 creates a modified B-spline Clenshaw-Curtis grid More...
 
static Grid * createModBsplineGrid (size_t dim, size_t degree)
 creates a modified B-spline grid More...
 
static Grid * createModFundamentalSplineGrid (size_t dim, size_t degree)
 creates a modified fundamental spline grid More...
 
static Grid * createModLinearClenshawCurtisGrid (size_t dim)
 creates a modified linear Clenshaw-Curtis grid More...
 
static Grid * createModLinearGrid (size_t dim)
 creates a modified linear grid More...
 
static Grid * createModLinearGridStencil (size_t dim)
 creates a stencil for a modified linear grid (without boundaries) More...
 
static Grid * createModPolyClenshawCurtisGrid (size_t dim, size_t degree)
 creates a modified poly grid with clenshaw curtis points More...
 
static Grid * createModPolyGrid (size_t dim, size_t degree)
 creates a modified polynomial grid More...
 
static Grid * createModWaveletGrid (size_t dim)
 creates a modified wavelet grid More...
 
static Grid * createNakBsplineBoundaryCombigridGrid (size_t dim, size_t degree)
 creates a not a knot B-Spline boundary grid More...
 
static Grid * createPeriodicGrid (size_t dim)
 creates a periodic grid More...
 
static Grid * createPolyBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a polynomial grid with truncated boundary More...
 
static Grid * createPolyClenshawCurtisBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a poly Clenshaw Curtis boundary grid with clenshaw curtis points More...
 
static Grid * createPolyClenshawCurtisGrid (size_t dim, size_t degree)
 creates a poly grid with clenshaw curtis points More...
 
static Grid * createPolyGrid (size_t dim, size_t degree)
 creates a polynomial grid More...
 
static Grid * createPrewaveletGrid (size_t dim)
 creates a prewavelet grid More...
 
static Grid * createSquareRootGrid (size_t dim)
 creates a square root grid (h-grid) More...
 
static Grid * createWaveletBoundaryGrid (size_t dim)
 creates a wavelet trapezoid boundary grid More...
 
static Grid * createWaveletGrid (size_t dim)
 creates a wavelet grid More...
 
static GridType stringToGridType (const std::string &gridType)
 Conversion from string to grid type. More...
 
static Grid * unserialize (const std::string &istr)
 reads a grid out of a string More...
 
static Grid * unserialize (std::istream &istr)
 reads a grid out of a stream More...
 
- Protected Types inherited from sgpp::base::Grid
typedef Grid *(* Factory) (std::istream &)
 
typedef std::map< std::string, Grid::Factory > factoryMap
 
typedef std::map< sgpp::base::GridType, std::string > gridTypeVerboseMap
 
- Static Protected Member Functions inherited from sgpp::base::Grid
static Grid * nullFactory (std::istream &)
 Factory for everything we don't know. More...
 

Detailed Description

grid with linear base functions

Member Typedef Documentation

◆ IndexStencil

typedef std::vector<unsigned int> sgpp::base::GridStencil::IndexStencil

◆ WeightStencil

typedef std::vector<float> sgpp::base::GridStencil::WeightStencil

Constructor & Destructor Documentation

◆ GridStencil() [1/3]

sgpp::base::GridStencil::GridStencil ( std::istream &  istr)
explicitprotected

◆ GridStencil() [2/3]

sgpp::base::GridStencil::GridStencil ( size_t  dim)
explicit

Constructor Linear Grid without boundaries.

Parameters
dimthe dimension of the grid

◆ GridStencil() [3/3]

sgpp::base::GridStencil::GridStencil ( BoundingBox &  BB)
explicit

Constructor Linear Grid.

Parameters
BBthe BoundingBox of the grid

◆ ~GridStencil()

sgpp::base::GridStencil::~GridStencil ( )
override

Destructor.

Member Function Documentation

◆ getNeighborStencil()

const GridStencil::IndexStencil & sgpp::base::GridStencil::getNeighborStencil ( ) const
virtual

Get the neighbor stencil, in fact an array of unsigned ints.

References neighborStencil.

◆ getSurplusStencil()

const GridStencil::IndexStencil & sgpp::base::GridStencil::getSurplusStencil ( ) const
virtual

Get the surplus stencil, in fact an array of unsigned ints.

References surplusStencil.

◆ getWeightStencil()

const GridStencil::WeightStencil & sgpp::base::GridStencil::getWeightStencil ( ) const
virtual

Get the weight stencil, in fact an array of floats.

References weightStencil.

Member Data Documentation

◆ neighborStencil

IndexStencil sgpp::base::GridStencil::neighborStencil
protected

Referenced by getNeighborStencil().

◆ surplusStencil

IndexStencil sgpp::base::GridStencil::surplusStencil
protected

Referenced by getSurplusStencil().

◆ weightStencil

WeightStencil sgpp::base::GridStencil::weightStencil
protected

Referenced by getWeightStencil().


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