Template Class DistributedSparseGridUniform

Defined in File DistributedSparseGridUniform.hpp

Inheritance Relationships

Base Type

public combigrid::AnyDistributedSparseGrid (Class AnyDistributedSparseGrid)

Class Documentation

template<typename FG_ELEMENT> class DistributedSparseGridUniform : public combigrid::AnyDistributedSparseGrid 

a distributed sparse grid with uniform domain decomposition (on all process groups)

This class can store a distributed sparse grid with a uniform space decomposition. During construction no data is created and the data size of the subspaces is initialized to zero (data sizes are usually set the first time by registering the dsg in a distributed fullgrid during local reduce). The data can be explicitly created by calling the createSubspaceData() method or is implicitly generated as soon as it is accessed. By calling deleteSubspaceData() the data can be deallocated.

Public Types

using ElementType = FG_ELEMENT 

Public Functions

explicit DistributedSparseGridUniform(DimType dim, const LevelVector &lmax, const LevelVector &lmin, CommunicatorType comm)

create sparse grid

No data is allocated and the sizes of the subspace data is initialized to 0.

Parameters:

dim – dimensionality of the grid
lmax – maximum level of the grid
lmin – minimum level of the grid
comm – communicator for the grid

explicit DistributedSparseGridUniform(DimType dim, const std::vector<LevelVector> &subspaces, CommunicatorType comm): create an empty (no data) sparse grid with given subspaces.

virtual ~DistributedSparseGridUniform() = default

DistributedSparseGridDataContainer<FG_ELEMENT> &getDataContainer()

void swapDataContainers(DistributedSparseGridDataContainer<FG_ELEMENT> &otherContainer)

void allocateDifferentSubspaces(std::set<SubspaceIndexType> &&subspaces): (re-)allocate memory for (another) set of subspaces

const std::set<SubspaceIndexType> &getCurrentlyAllocatedSubspaces() const

bool isSubspaceCurrentlyAllocated(SubspaceIndexType subspaceIndex) const

void print(std::ostream &os) const: print the subspace sizes of the grid to the output stream

void createSubspaceData()

allocates memory for subspace data

Zero initializes the dsgu data in case no data is already present. Otherwise nothing happens.

void createKahanBuffer(): allocates memory for kahan term data

void deleteSubspaceData()

deletes memory for subspace data and invalidates pointers to subspaces

Deallocates the dsgu data. This affects the values stored at the grid points and pointers which address the subspaces data.

void setZero(): sets all data elements to value zero, allocates if not yet allocated

inline const std::vector<LevelVector> &getAllLevelVectors() const: get the level vectors of all subspaces

inline const LevelVector &getLevelVector(SubspaceIndexType i) const: get the level vector of subspace i

inline const LevelVector &getLevelVector(size_t i) const

inline SubspaceIndexType getIndexInRange(const LevelVector &l, IndexType lowerBound) const

get the subspace index corresponding to a level vector

uses a lowerBound to search for the level vector in the range of levels_

Parameters:

l – level vector
lowerBound – lower bound for the search

inline SubspaceIndexType getIndex(const LevelVector &l) const

get the subspace index corresponding to a level vector

for an optimized search,