Skip to main content

Crate xdmf

Crate xdmf 

Source
Expand description

A library for writing XDMF files, which are commonly used in scientific simulations for visualizing datasets on meshes, for example with Paraview.

The XDMF (eXtensible Data Model and Format) stores the metadata in XML files and the actual data in different formats, most commonly in HDF5 files.

Re-exports§

pub use xdmf_elements::CellType;

Modules§

xdmf_elements
This module contains the main XDMF elements along with their serialization logic.

Structs§

DataInfo
Metadata about one field the reader found at a time step, sized so the caller can allocate a buffer before reading the data.
TimeSeriesDataWriter
Writer for time series data in XDMF format. Can be used after writing the mesh with TimeSeriesWriter::write_mesh.
TimeSeriesReader
Reads an XDMF time series: the parsed light data, the mesh’s metadata (including, for a mesh with submeshes, which points and cells each one holds), and every read call against it.
TimeSeriesWriter
Writer for time series data in XDMF format.
TimeStep
A single time step being written, handed to the closure passed to TimeSeriesDataWriter::write_time_step.

Enums§

DataAttribute
Type of the data (scalar, vector, tensor, etc.)
DataStorage
Type of storage used for the heavy data (e.g. ASCII or HDF5)
Error
The error type for all fallible operations in this crate.
ErrorKind
Stable, fieldless category for an Error, mirroring std::io::ErrorKind.
SubmeshCells
The cells of one submesh, as TimeSeriesWriter::write_mesh_with_submeshes takes them.
Values
Wrapper around different types of data, used to provide a unified interface.

Traits§

ConnectivityIndex
A type usable as a connectivity index: u32, u64, i32 or i64
Coordinate
A type usable as a point coordinate: f32 or f64
ValueType
A type a TimeSeriesReader read call can fill a buffer with: f32, f64, i32, i64, u32 or u64, mirroring the Values variants.

Functions§

is_hdf5_enabled
Check if the hdf5 feature is enabled.
mpi_safe_create_dir_all
Create directories in a way that is safe for MPI applications.

Type Aliases§

Result
Result alias defaulting to this crate’s Error type.