Public Member Functions | Friends | List of all members
openPMD::MeshRecordComponent Class Reference
Inheritance diagram for openPMD::MeshRecordComponent:
Inheritance graph
Collaboration diagram for openPMD::MeshRecordComponent:
Collaboration graph

Public Member Functions

template<typename T >
std::vector< T > position () const
 Position on an element. More...
template<typename T >
MeshRecordComponentsetPosition (std::vector< T > pos)
 Position on an element. More...
template<typename T >
MeshRecordComponentmakeConstant (T)
 Create a dataset with regular extent and constant value. More...
- Public Member Functions inherited from openPMD::RecordComponent
RecordComponentsetUnitSI (double)
RecordComponentresetDataset (Dataset)
 Declare the dataset's type and extent. More...
uint8_t getDimensionality () const
Extent getExtent () const
template<typename T >
RecordComponentmakeConstant (T)
 Create a dataset with regular extent and constant value. More...
template<typename T >
RecordComponentmakeEmpty (uint8_t dimensions)
 Create a dataset with zero extent in each dimension. More...
RecordComponentmakeEmpty (Datatype dt, uint8_t dimensions)
 Non-template overload of RecordComponent::makeEmpty(). More...
bool empty () const
 Returns true if this is an empty record component. More...
template<typename T >
std::shared_ptr< T > loadChunk (Offset={ 0u }, Extent={ -1u })
 Load and allocate a chunk of data. More...
template<typename T >
void loadChunk (std::shared_ptr< T >, Offset, Extent)
 Load a chunk of data into pre-allocated memory. More...
template<typename T >
void storeChunk (std::shared_ptr< T >, Offset, Extent)
template<typename T_ContiguousContainer >
std::enable_if< traits::IsContiguousContainer< T_ContiguousContainer >::value >::type storeChunk (T_ContiguousContainer &, Offset={0u}, Extent={-1u})
template<typename T , typename F >
DynamicMemoryView< T > storeChunk (Offset, Extent, F &&createBuffer)
 Overload of storeChunk() that lets the openPMD API allocate a buffer. More...
template<typename T >
DynamicMemoryView< T > storeChunk (Offset, Extent)
 Overload of span-based storeChunk() that uses operator new() to create a buffer.
- Public Member Functions inherited from openPMD::BaseRecordComponent
double unitSI () const
BaseRecordComponentresetDatatype (Datatype)
Datatype getDatatype () const
bool constant () const
 Returns true if this is a constant record component. More...
ChunkTable availableChunks ()
 Get data chunks that are available to be loaded from the backend. More...
- Public Member Functions inherited from openPMD::AttributableInterface
Attribute getAttribute (std::string const &key) const
 Retrieve value of Attribute stored with provided key. More...
bool deleteAttribute (std::string const &key)
 Remove Attribute of provided value both logically and physically. More...
std::vector< std::string > attributes () const
 List all currently stored Attributes' keys. More...
size_t numAttributes () const
 Count all currently stored Attributes. More...
bool containsAttribute (std::string const &key) const
 Check whether am Attribute with a given key exists. More...
std::string comment () const
 Retrieve a user-supplied comment associated with the object. More...
AttributableInterfacesetComment (std::string const &comment)
 Populate Attribute corresponding to a comment with the user-supplied comment. More...
void seriesFlush ()
 Flush the corresponding Series object. More...
MyPath myPath () const
 The path to this object within its containing Series. More...
template<typename T >
bool setAttribute (std::string const &key, T value)
 Populate Attribute of provided name with provided value. More...
bool setAttribute (std::string const &key, char const value[])


template<typename T , typename T_key , typename T_container >
class Container
class Mesh

Additional Inherited Members

- Public Types inherited from openPMD::RecordComponent
enum  Allocation { USER, API, AUTO }
- Static Public Attributes inherited from openPMD::RecordComponent
static constexpr const char *const SCALAR = "\vScalar"
- Protected Types inherited from openPMD::AttributableInterface
enum  ReadMode { IgnoreExisting, OverrideExisting, FullyReread }
- Protected Member Functions inherited from openPMD::RecordComponent
void readBase ()
- Protected Member Functions inherited from openPMD::AttributableInterface
 AttributableInterface (internal::AttributableData *)
template<typename T >
 AttributableInterface (T *attri)
const internal::SeriesInternalretrieveSeries () const
internal::SeriesInternalretrieveSeries ()
void seriesFlush (FlushLevel)
void flushAttributes ()
void readAttributes (ReadMode)
template<typename T >
readFloatingpoint (std::string const &key) const
 Retrieve the value of a floating point Attribute of user-defined precision with ensured type-safety. More...
template<typename T >
std::vector< T > readVectorFloatingpoint (std::string const &key) const
 Retrieve a vector of values of a floating point Attributes of user-defined precision with ensured type-safety. More...
AbstractIOHandlerIOHandler ()
const AbstractIOHandlerIOHandler () const
Writable *& parent ()
const Writableparent () const
Writablewritable ()
const Writablewritable () const
internal::AttributableDataget ()
const internal::AttributableDataget () const
bool dirty () const
bool & dirty ()
bool written () const
bool & written ()
const IterationcontainingIteration () const
 Returns the corresponding Iteration. More...
IterationcontainingIteration ()
- Protected Attributes inherited from openPMD::RecordComponent
std::shared_ptr< std::queue< IOTask > > m_chunks
std::shared_ptr< Attributem_constantValue
std::shared_ptr< bool > m_isEmpty = std::make_shared< bool >( false )
std::shared_ptr< bool > m_hasBeenExtended
std::shared_ptr< std::string > m_name = std::make_shared< std::string >()
 The same std::string that the parent class would pass as parameter to RecordComponent::flush(). More...
- Protected Attributes inherited from openPMD::BaseRecordComponent
std::shared_ptr< Datasetm_dataset
std::shared_ptr< bool > m_isConstant
- Protected Attributes inherited from openPMD::LegacyAttributable
std::shared_ptr< internal::AttributableDatam_attributableData
- Protected Attributes inherited from openPMD::AttributableInterface
internal::AttributableDatam_attri = nullptr

Member Function Documentation

◆ makeConstant()

template<typename T >
MeshRecordComponent & openPMD::MeshRecordComponent::makeConstant ( value)

Create a dataset with regular extent and constant value.

In a constant record component, the value for each date in its extent is the same. Implemented by storing only a constant value as meta-data.

See also
Template Parameters
Ttype of the stored value
A reference to this RecordComponent.

◆ position()

template<typename T >
std::vector< T > openPMD::MeshRecordComponent::position

Position on an element.

Relative on an element (node/cell/voxel) of the mesh

relative position within range of [0.0:1.0)

◆ setPosition()

template<typename T >
template MeshRecordComponent & openPMD::MeshRecordComponent::setPosition ( std::vector< T >  pos)

Position on an element.

Relative on an element (node/cell/voxel) of the mesh

[in]posrelative position in range [0.0:1.0)

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