GitHub

openPMD.jl

openPMD.Access — Type
@enum Access begin
    ACCESS_READ_ONLY
    ACCESS_READ_WRITE
    ACCESS_CREATE
end
source
openPMD.Dataset — Type
mutable struct Dataset
    ...
end
Dataset(::Type{<:OpenPMDType}, extent::Extent, options::AbstractString="{}")
Dataset(extent::Extent)

Datasets only describe a dataset, they do not hold any data. Datasets are value objects that can be copied.

source
openPMD.Datatype — Type
@enum Datatype begin
    CHAR => CxxChar
    UCHAR => CxxUChar
    SHORT => CxxShort
    INT => CxxInt
    LONG => CxxLong,
    LONGLONG => CxxLongLong
    USHORT => CxxUShort
    UINT => CxxUInt
    ULONG => CxxULong,
    ULONGLONG => CxxULongLong
    FLOAT => CxxFloat
    DOUBLE => CxxDouble,
    CFLOAT => Complex{CxxFloat}
    CDOUBLE => Complex{CxxDouble}
    STRING => String,
    VEC_CHAR => Vector{CxxChar}
    VEC_UCHAR => Vector{CxxUChar}
    VEC_SHORT => Vector{CxxShort},
    VEC_INT => Vector{CxxInt}
    VEC_LONG => Vector{CxxLong}
    VEC_LONGLONG => Vector{CxxLongLong},
    VEC_USHORT => Vector{CxxUShort}
    VEC_UINT => Vector{CxxUInt}
    VEC_ULONG => Vector{CxxULong},
    VEC_ULONGLONG => Vector{CxxULongLong}
    VEC_FLOAT => Vector{CxxFloat},
    VEC_DOUBLE => Vector{CxxDouble}
    VEC_CFLOAT => Vector{Complex{CxxFloat}},
    VEC_CDOUBLE => Vector{Complex{CxxDouble}}
    VEC_STRING => Vector{String}
    BOOL => CxxBool,
    ARR_DBL_7 => SVector{7,CxxDouble})
end
source
openPMD.Format — Type
@enum Format begin
    FORMAT_HDF5
    FORMAT_ADIOS2_BP
    FORMAT_ADIOS2_BP4
    FORMAT_ADIOS2_BP5
    FORMAT_ADIOS2_SST
    FORMAT_ADIOS2_SSC
    FORMAT_JSON
    FORMAT_DUMMY
end
source
openPMD.Geometry — Type
@enum Geometry begin
    GEOMETRY_cartesian
    GEOMETRY_theta_mode
    GEOMETRY_cylindrical
    GEOMETRY_spherical
    GEOMETRY_other
end
source
openPMD.Offset — Type
const Offset = NTuple{D,Int}

Offset describes the location of a dataset in the containing mesh's index space. See Extent.

source
openPMD.Series — Type
mutable struct Series <: Attributable
    ...
end
Series()
Series(filepath::AbstractString, access::Access, comm::MPI.Comm, options::AbstractString="{}")
Series(filepath::AbstractString, access::Access, options::AbstractString="{}")
source
openPMD.UnitDimension — Type
@enum UnitDimension begin
    UNITDIMENSION_L    # length
    UNITDIMENSION_M    # mass
    UNITDIMENSION_T    # time
    UNITDIMENSION_I    # electric current
    UNITDIMENSION_θ    # thermodynamic temperature
    UNITDIMENSION_N    # amount of substance
    UNITDIMENSION_J    # luminous intensity
end
source
Base.eltype — Method
eltype(::Type{Iterations})::Type
eltype(::Iterations)::Type
source
Base.flush — Function
flush(series::Series, backendConfig::AbstractString="{}")::Nothing
source
Base.getindex — Function
getindex(iters::WriteIterations, key)::Iteration
iters[key]::Iteration

This function inserts a new Iteration into the WriteIterations object if they key does not yet exist. This is the proper way to create a new Iteration.

There is no corresponding setindex! method since Iteration objects cannot exist independent of a Series.

source
Base.getindex — Method
getindex(iters::Iterations, n::Integer)::IterationsRecordComponent
iters[n]
source
Base.getindex — Method
getindex(mesh::Mesh, name::AbstractString)::MeshRecordComponent
mesh[name]
source
Base.getindex — Method
getindex(meshes::Meshes, name::AbstractString)::MeshesRecordComponent
meshes[name]
source
Base.in — Method
in(name::AbstractString, meshes::Meshes)::Bool
name in mesh
source
Base.in — Method
in(name::AbstractString, mesh::Mesh)::Bool
name in mesh
source
Base.in — Method
in(n::Integer, iters::Iterations)::Bool
n in iters
source
Base.keys — Method
keys(meshes::Meshes)::AbstractVector{<:AbstractString}
source
Base.keys — Method
keys(mesh::Mesh)::AbstractVector{<:AbstractString}
source
Base.keytype — Method
keytype(::Type{Iterations})::Type
keytype(::Iterations)::Type
source
Base.setindex! — Method
setindex!(iters::Iterations, iter::Iteration, n::Integer)
iters[n] = iter
source
Base.setindex! — Method
setindex!(mesh::Mesh, comp::MeshRecordComponent, name::AbstractString)
mesh[name] = comp
source
Base.setindex! — Method
setindex!(meshes::Meshes, comp::MeshesRecordComponent, name::AbstractString)
meshes[name] = mesh
source
openPMD.is_integer — Method
is_integer(::Type)::Tuple{Bool,Bool}

Whether the type is an integer (first tuple element), and if so, whether it is signed (second tuple element).

source
openPMD.load_chunk — Function
TODO: update
data = load_chunk(comp::RecordComponent, offset::Offset, extent::Extent)
source
openPMD.set_position! — Method
set_position!(comp::MeshRecordComponent, newpos::Union{NTuple{D,CxxDouble}, AbstractVector{CxxDouble}})
source
openPMD.store_chunk — Function
TODO: update
store_chunk(comp::RecordComponent, data::AbstractArray, offset::Offset, extent::Extent)
source