Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tdegeus/xdmfwrite_highfive
XDFM meets HighFive: Write XDFM files to interpret HDF5 files
https://github.com/tdegeus/xdmfwrite_highfive
Last synced: 11 days ago
JSON representation
XDFM meets HighFive: Write XDFM files to interpret HDF5 files
- Host: GitHub
- URL: https://github.com/tdegeus/xdmfwrite_highfive
- Owner: tdegeus
- License: mit
- Created: 2020-05-29T08:04:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-04T10:18:04.000Z (over 3 years ago)
- Last Synced: 2024-04-16T06:53:21.679Z (7 months ago)
- Language: C++
- Homepage:
- Size: 181 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/tdegeus/XDMFWrite_HighFive/actions)
[](https://tdegeus.github.io/XDMFWrite_HighFive)
[](https://anaconda.org/conda-forge/XDMFWrite_HighFive)
# XDMFWrite_HighFive
- [Getting started](#getting-started)
- [Fields](#fields)
- [Geometry \(nodal-coordinates or vertices\)](#geometry-nodal-coordinates-or-vertices)
- [Topology \(connectivity\)](#topology-connectivity)
- [Attribute](#attribute)
- [Short-hand](#short-hand)
- [Unstructured](#unstructured)
- [Structured](#structured)
- [Grids](#grids)
- [Grid](#grid)
- [TimeSeries](#timeseries)
- [Output](#output)
- [write](#write)
- [Miscellaneous](#miscellaneous)
- [Join sequence of strings](#join-sequence-of-strings)
- [Concatenate vectors](#concatenate-vectors)
- [Change the indentation](#change-the-indentation)
## Getting started
XDMF meets HighFive: Write XDMF files to interpret HDF5 files.
To get started consider the [examples](./docs/examples):
- [grid_structured](./docs/examples/grid_structured.cpp)
- [grid_unstructured](./docs/examples/grid_unstructured.cpp)
## Fields
### Geometry (nodal-coordinates or vertices)
Interpret a DataSet as a Geometry (a.k.a. nodal-coordinates or vertices).
### Topology (connectivity)
Interpret a DataSet as a Topology (a.k.a. connectivity).
### Attribute
Interpret a DataSet as an Attribute.
## Short-hand
### Unstructured
Interpret a DataSets as Unstructured.
The call
```cpp
Structured(file, "/path/to/geometry", "/path/to/topology", type);
```
Is simply short for
```cpp
concatenate({
Geometry(file, "/path/to/geometry"), // nodal-coordinates / vertices
Topology(file, "/path/to/topology", type) // connectivity
});
```
### Structured
Interpret a DataSets as Structured (individual points).
Use is made of a mock Topology `arange(N)`, with `N` the number of nodes (vertices).
The call
```cpp
Structured(file, "/path/to/geometry", "/path/to/topology");
```
Is simply short for
```cpp
concatenate({
Geometry(file, "/path/to/geometry"), // nodal-coordinates / vertices
Topology(file, "/path/to/topology", ElementType::Polyvertex) // mock connectivity
});
```
## Grids
### Grid
Combine fields (e.g. Geometry, Topology, and Attribute) to a single grid.
### TimeSeries
Combine a series of fields (e.g. Geometry, Topology, and Attribute) to a time-series.
The syntax is as follows:
```cpp
TimeSeries series;
series.push_back(...);
series.push_back(...);
```
To then write a file simply pass `series` to `write`.
To alternatively get the sequence of strings of TimeSeries use `series.get()`.
## Output
### write
Write a complete XDMF-file, e.g. from Grid or TimeSeries.
## Miscellaneous
### Join sequence of strings
Join a sequence of strings:
```cpp
std::vector lines = {"foo", "bar"};
std::string single = join(lines);
std::cout << single << std::endl;
```
### Concatenate vectors
Concatenate an arbitrary number of vectors:
```cpp
concatenate({...});
```
### Change the indentation
The indentation can be changed by specifying
```cpp
#define XDMFWRITE_HIGHFIVE_INDENT 4
```
before
```cpp
#include
```