openPMD-api
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level
1
2
3
4
]
►
N
openPMD
Public definitions of openPMD-api
►
N
auxiliary
►
N
detail
C
IsArray
C
IsArray< std::array< T, n > >
C
IsPointer
C
IsPointer< std::shared_ptr< T > >
C
IsPointer< std::unique_ptr< T, Del > >
C
IsPointer< T * >
C
IsPointer< UniquePtrWithLambda< T > >
C
IsVector
C
IsVector< std::vector< T > >
C
CustomDelete
Custom deleter type based on std::function
C
OutOfRangeMsg
Return an error string for read-only access
C
Variant
Generic object to store a set of datatypes in without losing type safety
C
WriteBuffer
►
N
benchmark
C
MemoryProfiler
The Memory profiler class for profiling purpose
C
Timer
For profiling purpose
►
N
detail
C
AttributeInfo
C
AttributeReader
C
AttributeTypes
C
AttributeTypes< bool >
C
AttributeTypes< std::array< T, n > >
C
AttributeTypes< std::complex< long double > >
C
AttributeTypes< std::vector< std::complex< long double > > >
C
AttributeTypes< std::vector< std::string > >
C
AttributeTypes< std::vector< T > >
C
AttributeWithShape
Pointer to an attribute's data along with its shape
C
AttributeWriter
C
BasicDatatype
C
BufferedAction
►
C
BufferedActions
C
ADIOS2FlushParams
C
BufferedAttributeRead
C
BufferedAttributeWrite
C
BufferedGet
C
BufferedPut
C
BufferedUniquePtrPut
C
CallUndefinedDatatype
Purpose of this struct is to detect at compile time whether Action::template operator()<0>() exists
C
DatasetExtender
C
DatasetHelper
C
DatasetOpener
C
DatasetReader
C
DatasetTypes
C
DefaultValue
Functor template to be used in combination with switchType::operator() to set a default value for constant record components via the respective type's default constructor
C
GetSpan
C
HasErrorMessageMember
C
HasErrorMessageMember< T, void_t< decltype(std::string(T::errorMsg))> >
C
HasOperators
C
I_UpdateSpan
C
MakeEmpty
C
OldAttributeReader
C
OldAttributeWriter
C
OldBufferedAttributeRead
►
C
PreloadAdiosAttributes
Class that is responsible for scheduling and buffering
openPMD
attribute loads from ADIOS2, if using ADIOS variables to store
openPMD
attributes
C
AttributeLocation
Internally used struct to store meta information on a buffered attribute
C
RetrieveBlocksInfo
C
RunUniquePtrPut
C
ToDatatype
C
ToDatatypeHelper
C
ToDatatypeHelper< bool >
C
ToDatatypeHelper< std::array< T, n > >
C
ToDatatypeHelper< std::vector< T > >
C
ToVectorType
C
UpdateSpan
C
VariableDefiner
C
WriteDataset
►
N
error
C
BackendConfigSchema
C
Internal
Internal
errors that should not happen
C
NoSuchAttribute
C
OperationUnsupportedInBackend
An operation was requested that is not supported in a specific backend
C
ReadError
C
WrongAPIUsage
The API was used in an illegal way
►
N
internal
Writing side of the streaming API
C
AttributableData
C
BaseRecordComponentData
C
BaseRecordData
C
ContainerData
C
DeferredParseAccess
C
EraseStaleEntries
This class wraps a
Container
and forwards operator[]() and at() to it
C
FlushParams
Parameters recursively passed through the
openPMD
hierarchy when flushing
C
IterationData
C
ParsedFlushParams
C
PatchRecordComponentData
C
RecordComponentData
C
SeriesData
Data members for
Series
►
N
json
C
ParsedConfig
C
TracingJSON
Extend nlohmann::json with tracing of which keys have been accessed by operator[]()
►
N
traits
C
GenerationPolicy
Container
Element Creation Policy
C
GenerationPolicy< ParticleSpecies >
C
AbstractFilePosition
C
AbstractIOHandler
Interface for communicating between logical and physically persistent data
C
AbstractIOHandlerImpl
C
AbstractIOHandlerImplCommon
C
AbstractParameter
C
ADIOS1FilePosition
C
ADIOS1IOHandler
C
ADIOS1IOHandlerImpl
C
ADIOS2FilePosition
C
ADIOS2IOHandler
C
ADIOS2IOHandlerImpl
►
C
Attributable
Layer to manage storage of attributes associated with file objects
C
MyPath
String serialization to describe an
Attributable
C
Attribute
Varidic datatype supporting at least all formats for attributes specified in the
openPMD
standard
C
BaseRecord
C
BaseRecordComponent
C
BlockSlicer
Abstract class to associate a thread with its local cuboid in the total cuboid
C
ChunkInfo
Represents the meta info around a chunk in a dataset
►
C
CommonADIOS1IOHandlerImpl
C
ScheduledRead
C
Container
Map-like container that enforces
openPMD
requirements and handles IO
C
Dataset
C
DatasetFiller
An abstract class to create one iteration of data per thread
C
decay_equiv
Fundamental equivalence check for two given types T and U
C
DummyIOHandler
Dummy handler without any IO operations
C
DynamicMemoryView
A view into a buffer that might be reallocated at some points and thus has changing base pointers over time
C
Error
Base class for all openPMD-specific error types
►
C
File
C
FileState
C
GetH5DataType
C
HDF5FilePosition
C
HDF5IOHandler
C
HDF5IOHandlerImpl
C
IndexedIteration
Subclass of
Iteration
that knows its own index withing the containing
Series
►
C
InvalidatableFile
Wrapper around a shared pointer to:
C
FileState
C
IOTask
Self-contained description of a single IO operation
C
Iteration
Logical compilation of data from one snapshot (e.g
C
JSONFilePosition
C
JSONIOHandler
C
JSONIOHandlerImpl
C
Mesh
Container
for N-dimensional, homogeneous Records
C
MeshRecordComponent
C
MPIBenchmark
Class representing a benchmark
C
MPIBenchmarkReport
The report for a single benchmark produced by <openPMD/benchmark/mpi/MPIBenchmark>
C
OneDimensionalBlockSlicer
C
ParallelADIOS1IOHandler
C
ParallelADIOS1IOHandlerImpl
C
ParallelHDF5IOHandler
C
ParallelHDF5IOHandlerImpl
C
Parameter
Typesafe description of all required arguments for a specified Operation
C
Parameter< Operation::ADVANCE >
C
Parameter< Operation::AVAILABLE_CHUNKS >
C
Parameter< Operation::CHECK_FILE >
C
Parameter< Operation::CLOSE_FILE >
C
Parameter< Operation::CLOSE_PATH >
C
Parameter< Operation::CREATE_DATASET >
C
Parameter< Operation::CREATE_FILE >
C
Parameter< Operation::CREATE_PATH >
C
Parameter< Operation::DELETE_ATT >
C
Parameter< Operation::DELETE_DATASET >
C
Parameter< Operation::DELETE_FILE >
C
Parameter< Operation::DELETE_PATH >
C
Parameter< Operation::DEREGISTER >
C
Parameter< Operation::EXTEND_DATASET >
►
C
Parameter< Operation::GET_BUFFER_VIEW >
C
OutParameters
C
Parameter< Operation::KEEP_SYNCHRONOUS >
C
Parameter< Operation::LIST_ATTS >
C
Parameter< Operation::LIST_DATASETS >
C
Parameter< Operation::LIST_PATHS >
C
Parameter< Operation::OPEN_DATASET >
C
Parameter< Operation::OPEN_FILE >
C
Parameter< Operation::OPEN_PATH >
C
Parameter< Operation::READ_ATT >
C
Parameter< Operation::READ_DATASET >
C
Parameter< Operation::WRITE_ATT >
C
Parameter< Operation::WRITE_DATASET >
C
ParticlePatches
C
ParticleSpecies
C
PatchRecord
C
PatchRecordComponent
C
RandomDatasetFiller
C
ReadIterations
Reading side of the streaming API
C
Record
C
RecordComponent
►
C
Series
Implementation for the root level of the
openPMD
hierarchy
C
ParsedInput
C
SeriesIterator
C
SimpleDatasetFillerProvider
C
Span
Subset of C++20 std::span class template
C
UniquePtrWithLambda
Unique Pointer class that uses a dynamic destructor type
C
Writable
Layer to mirror structure of logical data and persistent data in file
C
WriteIterations
C
WrittenChunkInfo
Represents the meta info around a chunk that has been written by some data producing application
►
N
openpmd_api
►
N
DaskArray
C
DaskRecordComponent
►
N
ls
►
N
pipe
►
N
__main__
C
Chunk
C
deferred_load
C
FallbackMPICommunicator
C
particle_patch_load
C
pipe
►
N
std
STL namespace
C
hash< openPMD::File >
C
hash< openPMD::InvalidatableFile >
C
openPMD_PyMPICommObject
Mpi4py communicator wrapper
C
PythonDynamicMemoryView
C
SetAttributeFromObject
Generated by
1.8.13