ViennaLS
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
viennals::PointData< T, > Class Template Reference

This class holds data associated with points in space. More...

#include <lsPointData.hpp>

Public Types

typedef std::vector< T > ScalarDataType
 
typedef std::vector< std::array< T, 3 > > VectorDataType
 

Public Member Functions

void insertNextScalarData (const ScalarDataType &scalars, const std::string &label="Scalars")
 insert new scalar data array
 
void insertNextScalarData (ScalarDataType &&scalars, const std::string &label="Scalars")
 insert new scalar data array
 
void insertNextVectorData (const VectorDataType &vectors, const std::string &label="Vectors")
 insert new vector data array
 
void insertNextVectorData (VectorDataType &&vectors, const std::string &label="Vectors")
 insert new vector data array
 
void insertReplaceScalarData (const ScalarDataType &scalars, const std::string &label="Scalars")
 insert or replace scalar data array
 
void insertReplaceScalarData (ScalarDataType &&scalars, const std::string &label="Scalars")
 insert or replace scalar data array
 
void insertReplaceVectorData (const VectorDataType &vectors, const std::string &label="Vectors")
 insert or replace vector data array
 
void insertReplaceVectorData (VectorDataType &&vectors, std::string label="Vectors")
 insert new vector data array
 
unsigned getScalarDataSize () const
 get the number of different scalar data arrays saved
 
unsigned getVectorDataSize () const
 get the number of different vector data arrays saved
 
ScalarDataType * getScalarData (int index)
 
const ScalarDataType * getScalarData (int index) const
 
ScalarDataType * getScalarData (const std::string &searchLabel, bool noWarning=false)
 
const ScalarDataType * getScalarData (const std::string &searchLabel, bool noWarning=false) const
 
int getScalarDataIndex (const std::string &searchLabel) const
 
std::string getScalarDataLabel (int index) const
 
void setScalarDataLabel (int index, std::string newLabel)
 
void eraseScalarData (int index)
 Delete the scalar data at index.
 
VectorDataType * getVectorData (int index)
 
const VectorDataType * getVectorData (int index) const
 
VectorDataType * getVectorData (const std::string &searchLabel, bool noWarning=false)
 
const VectorDataType * getVectorData (const std::string &searchLabel, bool noWarning=false) const
 
int getVectorDataIndex (const std::string &searchLabel) const
 
std::string getVectorDataLabel (int index) const
 
void setVectorDataLabel (int index, std::string newLabel)
 
void eraseVectorData (int index)
 Delete the vector data at index.
 
void append (const PointData &passedData)
 Append the passed PointData to this one.
 
void translateFromData (const PointData &source, const std::vector< unsigned > &indices)
 Add data in the passed source pointData into this data according to the indices passed. The index of the indices vector corresponds to the index of this data, while the values of indices correspond to the index in source.
 
void translateFromMultiData (const PointData &source, const std::vector< std::vector< unsigned > > &indicesVector)
 Same as translateFromData, but the indices are given as a vector, as is the case when collecting indices during parallel algorithms.
 
void clear ()
 Delete all data stored in this object.
 
bool empty ()
 Return whether this object is empty.
 
std::ostream & serialize (std::ostream &stream)
 Serialize PointData into a binary stream.
 
std::istream & deserialize (std::istream &stream)
 Deserialize PointData from a binary stream.
 

Detailed Description

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
class viennals::PointData< T, >

This class holds data associated with points in space.

Member Typedef Documentation

◆ ScalarDataType

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
typedef std::vector<T> viennals::PointData< T, >::ScalarDataType

◆ VectorDataType

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
typedef std::vector<std::array<T, 3> > viennals::PointData< T, >::VectorDataType

Member Function Documentation

◆ append()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::append ( const PointData< T, > & passedData)
inline

Append the passed PointData to this one.

◆ clear()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::clear ( )
inline

Delete all data stored in this object.

◆ deserialize()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
std::istream & viennals::PointData< T, >::deserialize ( std::istream & stream)
inline

Deserialize PointData from a binary stream.

◆ empty()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
bool viennals::PointData< T, >::empty ( )
inline

Return whether this object is empty.

◆ eraseScalarData()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::eraseScalarData ( int index)
inline

Delete the scalar data at index.

◆ eraseVectorData()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::eraseVectorData ( int index)
inline

Delete the vector data at index.

◆ getScalarData() [1/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
ScalarDataType * viennals::PointData< T, >::getScalarData ( const std::string & searchLabel,
bool noWarning = false )
inline

◆ getScalarData() [2/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
const ScalarDataType * viennals::PointData< T, >::getScalarData ( const std::string & searchLabel,
bool noWarning = false ) const
inline

◆ getScalarData() [3/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
ScalarDataType * viennals::PointData< T, >::getScalarData ( int index)
inline

◆ getScalarData() [4/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
const ScalarDataType * viennals::PointData< T, >::getScalarData ( int index) const
inline

◆ getScalarDataIndex()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
int viennals::PointData< T, >::getScalarDataIndex ( const std::string & searchLabel) const
inline

◆ getScalarDataLabel()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
std::string viennals::PointData< T, >::getScalarDataLabel ( int index) const
inline

◆ getScalarDataSize()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
unsigned viennals::PointData< T, >::getScalarDataSize ( ) const
inline

get the number of different scalar data arrays saved

◆ getVectorData() [1/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
VectorDataType * viennals::PointData< T, >::getVectorData ( const std::string & searchLabel,
bool noWarning = false )
inline

◆ getVectorData() [2/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
const VectorDataType * viennals::PointData< T, >::getVectorData ( const std::string & searchLabel,
bool noWarning = false ) const
inline

◆ getVectorData() [3/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
VectorDataType * viennals::PointData< T, >::getVectorData ( int index)
inline

◆ getVectorData() [4/4]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
const VectorDataType * viennals::PointData< T, >::getVectorData ( int index) const
inline

◆ getVectorDataIndex()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
int viennals::PointData< T, >::getVectorDataIndex ( const std::string & searchLabel) const
inline

◆ getVectorDataLabel()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
std::string viennals::PointData< T, >::getVectorDataLabel ( int index) const
inline

◆ getVectorDataSize()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
unsigned viennals::PointData< T, >::getVectorDataSize ( ) const
inline

get the number of different vector data arrays saved

◆ insertNextScalarData() [1/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertNextScalarData ( const ScalarDataType & scalars,
const std::string & label = "Scalars" )
inline

insert new scalar data array

◆ insertNextScalarData() [2/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertNextScalarData ( ScalarDataType && scalars,
const std::string & label = "Scalars" )
inline

insert new scalar data array

◆ insertNextVectorData() [1/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertNextVectorData ( const VectorDataType & vectors,
const std::string & label = "Vectors" )
inline

insert new vector data array

◆ insertNextVectorData() [2/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertNextVectorData ( VectorDataType && vectors,
const std::string & label = "Vectors" )
inline

insert new vector data array

◆ insertReplaceScalarData() [1/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertReplaceScalarData ( const ScalarDataType & scalars,
const std::string & label = "Scalars" )
inline

insert or replace scalar data array

◆ insertReplaceScalarData() [2/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertReplaceScalarData ( ScalarDataType && scalars,
const std::string & label = "Scalars" )
inline

insert or replace scalar data array

◆ insertReplaceVectorData() [1/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertReplaceVectorData ( const VectorDataType & vectors,
const std::string & label = "Vectors" )
inline

insert or replace vector data array

◆ insertReplaceVectorData() [2/2]

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::insertReplaceVectorData ( VectorDataType && vectors,
std::string label = "Vectors" )
inline

insert new vector data array

◆ serialize()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
std::ostream & viennals::PointData< T, >::serialize ( std::ostream & stream)
inline

Serialize PointData into a binary stream.

◆ setScalarDataLabel()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::setScalarDataLabel ( int index,
std::string newLabel )
inline

◆ setVectorDataLabel()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::setVectorDataLabel ( int index,
std::string newLabel )
inline

◆ translateFromData()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::translateFromData ( const PointData< T, > & source,
const std::vector< unsigned > & indices )
inline

Add data in the passed source pointData into this data according to the indices passed. The index of the indices vector corresponds to the index of this data, while the values of indices correspond to the index in source.

◆ translateFromMultiData()

template<class T = double, lsConcepts::IsFloatingPoint< T > = lsConcepts::assignable>
void viennals::PointData< T, >::translateFromMultiData ( const PointData< T, > & source,
const std::vector< std::vector< unsigned > > & indicesVector )
inline

Same as translateFromData, but the indices are given as a vector, as is the case when collecting indices during parallel algorithms.

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