SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
sgpp::base::WaveletGrid Class Reference

grid with wavelet base functions More...

#include <WaveletGrid.hpp>

Inheritance diagram for sgpp::base::WaveletGrid:
sgpp::base::Grid

Public Member Functions

SBasisgetBasis () override
 Returns the Basis class associated with the grid.
 
GridGeneratorgetGenerator () override
 Creates new GridGenerator This must be changed if we add other storage types.
 
sgpp::base::GridType getType () override
 Returns a string that identifies the grid type uniquely.
 
 WaveletGrid (size_t dim)
 Constructor of grid with wavelet base functions.
 
 ~WaveletGrid () override
 Destructor.
 
- Public Member Functions inherited from sgpp::base::Grid
Gridclone ()
 copies a grid
 
GridcreateGridOfEquivalentType (size_t numDims)
 creates an equivalent grid without copying the grid points
 
std::vector< size_t > getAlgorithmicDimensions ()
 returns the algorithmic dimensions (the dimensions in which the Up Down operations should be applied)
 
virtual BoundingBoxgetBoundingBox ()
 gets a reference to the GridStorage's BoundingsBox object
 
size_t getDimension () const
 Returns the number of dimensions.
 
size_t getSize () const
 Returns the number of points on the grid.
 
virtual GridStoragegetStorage ()
 gets a reference to the GridStorage object
 
virtual StretchinggetStretching ()
 gets a reference to the GridStorage's Stretching object
 
std::string getTypeAsString ()
 Returns a string that identifies the grid type uniquely.
 
sgpp::base::GridType getZeroBoundaryType ()
 Returns the grid type that corresponds to the actual type but does no boundary treatment.
 
 Grid (const Grid &other)=delete
 delete copy constructor
 
void insertPoint (size_t dim, unsigned int levels[], unsigned int indices[], bool isLeaf)
 Insert one point to the grid.
 
void refine (DataVector &vector, int numOfPoints)
 Refine grid Refine the given number of points on the grid according to the vector.
 
std::string serialize (int version=SERIALIZATION_VERSION)
 Serializes grid to a string.
 
virtual void serialize (std::ostream &ostr, int version=SERIALIZATION_VERSION)
 Serializes the grid.
 
void serialize (std::string &ostr, int version=SERIALIZATION_VERSION)
 Serializes grid to a string.
 
void setAlgorithmicDimensions (std::vector< size_t > newAlgoDims)
 sets the algorithmic dimensions (the dimensions in which the Up Down operations should be applied)
 
virtual void setBoundingBox (BoundingBox &boundingBox)
 sets the GridStorage's BoundingsBox
 
virtual void setStretching (Stretching &stretching)
 sets the GridStorage's Stretching pointer to a Stretching object
 
virtual ~Grid ()
 Desctructor.
 

Static Public Member Functions

static Gridunserialize (std::istream &istr)
 
- Static Public Member Functions inherited from sgpp::base::Grid
static GridcreateBsplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a B-spline trapezoid boundary grid
 
static GridcreateBsplineClenshawCurtisGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a B-spline Clenshaw-Curtis grid
 
static GridcreateBsplineGrid (size_t dim, size_t degree)
 creates a B-spline grid
 
static GridcreateFundamentalNakSplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 
static GridcreateFundamentalSplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 
static GridcreateFundamentalSplineGrid (size_t dim, size_t degree)
 creates a fundamental spline grid
 
static GridcreateGrid (RegularGridConfiguration gridConfig)
 creates a grid defined by the grid configuration
 
static GridcreateLinearBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a linear boundary grid
 
static GridcreateLinearClenshawCurtisBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a linear Clenshaw-Curtis boundary grid
 
static GridcreateLinearClenshawCurtisGrid (size_t dim)
 creates a linear Clenshaw-Curtis grid
 
static GridcreateLinearGrid (size_t dim)
 Creates and returns a grid without grid points on the boundary (zero boundary conditions) with piecewise linear basis functions.
 
static GridcreateLinearGridStencil (size_t dim)
 creates a stencil for a linear grid (without boundaries)
 
static GridcreateLinearStretchedBoundaryGrid (size_t dim)
 creates a linearstretched truncated boundary grid
 
static GridcreateLinearStretchedGrid (size_t dim)
 creates a linear stretched grid without boundaries
 
static GridcreateLinearTruncatedBoundaryGrid (size_t dim)
 creates a truncated boundary grid=contains all the gridpoints of the fullgrids which have \(|l|<level and li>=l_user\)
 
static GridcreateModBsplineClenshawCurtisGrid (size_t dim, size_t degree)
 creates a modified B-spline Clenshaw-Curtis grid
 
static GridcreateModBsplineGrid (size_t dim, size_t degree)
 creates a modified B-spline grid
 
static GridcreateModFundamentalSplineGrid (size_t dim, size_t degree)
 creates a modified fundamental spline grid
 
static GridcreateModLinearClenshawCurtisGrid (size_t dim)
 creates a modified linear Clenshaw-Curtis grid
 
static GridcreateModLinearGrid (size_t dim)
 creates a modified linear grid
 
static GridcreateModLinearGridStencil (size_t dim)
 creates a stencil for a modified linear grid (without boundaries)
 
static GridcreateModNakBsplineGrid (size_t dim, size_t degree)
 
static GridcreateModPolyClenshawCurtisGrid (size_t dim, size_t degree)
 creates a modified poly grid with clenshaw curtis points
 
static GridcreateModPolyGrid (size_t dim, size_t degree)
 creates a modified polynomial grid
 
static GridcreateModWaveletGrid (size_t dim)
 creates a modified wavelet grid
 
static GridcreateModWeaklyFundamentalNakSplineGrid (size_t dim, size_t degree)
 
static GridcreateNakBsplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 
static GridcreateNakBsplineExtendedGrid (size_t dim, size_t degree)
 creates a not a knot B-Spline extended grid
 
static GridcreateNakBsplineGrid (size_t dim, size_t degree)
 creates a not a knot B-Spline grid
 
static GridcreateNakPBsplineGrid (size_t dim, size_t degree)
 creates a not a knot polynomial B-Spline extended grid
 
static GridcreateNaturalBsplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a not a knot B-Spline boundary grid
 
static GridcreatePeriodicGrid (size_t dim)
 creates a periodic grid
 
static GridcreatePolyBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a polynomial grid with truncated boundary
 
static GridcreatePolyClenshawCurtisBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 creates a poly Clenshaw Curtis boundary grid with clenshaw curtis points
 
static GridcreatePolyClenshawCurtisGrid (size_t dim, size_t degree)
 creates a poly grid with clenshaw curtis points
 
static GridcreatePolyGrid (size_t dim, size_t degree)
 creates a polynomial grid
 
static GridcreatePrewaveletGrid (size_t dim)
 creates a prewavelet grid
 
static GridcreateSquareRootGrid (size_t dim)
 creates a square root grid (h-grid)
 
static GridcreateWaveletBoundaryGrid (size_t dim, level_t boundaryLevel=1)
 creates a wavelet trapezoid boundary grid
 
static GridcreateWaveletGrid (size_t dim)
 creates a wavelet grid
 
static GridcreateWeaklyFundamentalNakSplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 
static GridcreateWeaklyFundamentalSplineBoundaryGrid (size_t dim, size_t degree, level_t boundaryLevel=1)
 
static GridType stringToGridType (const std::string &gridType)
 Conversion from string to grid type.
 
static Gridunserialize (const std::string &istr)
 reads a grid out of a string
 
static Gridunserialize (std::istream &istr)
 reads a grid out of a stream
 
static GridunserializeFromFile (std::string filename)
 opens a file given by name and reads a grid out of the stored string @ param filename name of the file
 

Protected Member Functions

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

Protected Attributes

StandardGridGenerator generator
 grid generator
 
- Protected Attributes inherited from sgpp::base::Grid
GridStorage storage
 GridStorage object of the grid.
 

Additional Inherited Members

- Protected Types inherited from sgpp::base::Grid
typedef Grid *(* Factory) (std::istream &)
 
typedef std::map< std::string, Grid::FactoryfactoryMap
 
typedef std::map< sgpp::base::GridType, std::string > gridTypeVerboseMap
 
- Static Protected Member Functions inherited from sgpp::base::Grid
static GridnullFactory (std::istream &)
 Factory for everything we don't know.
 

Detailed Description

grid with wavelet base functions

Constructor & Destructor Documentation

◆ WaveletGrid() [1/2]

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

◆ WaveletGrid() [2/2]

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

Constructor of grid with wavelet base functions.

Parameters
dimthe dimension of the grid

◆ ~WaveletGrid()

sgpp::base::WaveletGrid::~WaveletGrid ( )
override

Destructor.

Member Function Documentation

◆ getBasis()

SBasis & sgpp::base::WaveletGrid::getBasis ( )
overridevirtual

Returns the Basis class associated with the grid.

Returns
Basis class associated with the grid

Implements sgpp::base::Grid.

◆ getGenerator()

GridGenerator & sgpp::base::WaveletGrid::getGenerator ( )
overridevirtual

Creates new GridGenerator This must be changed if we add other storage types.

Implements sgpp::base::Grid.

References generator.

◆ getType()

sgpp::base::GridType sgpp::base::WaveletGrid::getType ( )
overridevirtual

Returns a string that identifies the grid type uniquely.

Returns
string that identifies the grid type uniquely

Implements sgpp::base::Grid.

References sgpp::base::Wavelet.

◆ unserialize()

Grid * sgpp::base::WaveletGrid::unserialize ( std::istream &  istr)
static

Member Data Documentation

◆ generator

StandardGridGenerator sgpp::base::WaveletGrid::generator
protected

grid generator

Referenced by getGenerator().


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