Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Ext: MeshRefinement #252

Open
wants to merge 1 commit into
base: upcoming-2.0.0
Choose a base branch
from
Open

Ext: MeshRefinement #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions EXT_MeshRefinement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Conventions for Mesh Refinement
===============================

openPMD extension name: `MeshRefinement`

Introduction
------------

This extension defines naming conventions to identify refined meshes.

Mesh Records
------------

Mesh refinement levels of a mesh record describe a higher resolution subselection of a mesh record.

### Additional Naming Conventions or Each Mesh `Record`

The coarsest level of a record is implicitly assigned the level `0` of a simulation.
The record names of finer levels are suffixed with `_lvl<N>` where `<N>` is the integer of the refined level.

A patch of a refinemnet level shall be a spatially hyperrectangular subselection of the previous level.
Multiple patches might exist in a refined level.

If the implemented file format supports sparse data sets, i.e. through efficient chunking of patches, the refined level must over the previous level in extend and store multiple patches through its chunking mechanism.

File formats that do not support efficient storage a sparesly populated refinement level can store continguous patches on the same level with an additional suffix `_<P>` where `<P>` is the number of the (hyperrectangular) patch in the refinement level.

### Additional Attributes

A mesh record describing a refined level shall add the following attribute:

- `refinementRatio`
- type: 1-dimensional array containing N *(int)*
elements, where N is the number of dimensions in the mesh
- description: the refinement ratio compared to the prior level
- advice to implementors: the order of the N values must be identical to the axes in `axisLabels`
14 changes: 8 additions & 6 deletions STANDARD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ meshes):

- `axisLabels`
- type: 1-dimensional array containing N *(string)*
elements, where N is the number of dimensions in the simulation
elements, where N is the number of dimensions in the mesh
- description: this attribute assigns human-readible labels for the
indices `i`, `j`, `k`, etc. denoting the axes of a mesh
`A_{i,j,k}`
Expand All @@ -392,7 +392,7 @@ meshes):

- `gridSpacing`
- type: 1-dimensional array containing N *(floatX)*
elements, where N is the number of dimensions in the simulation
elements, where N is the number of dimensions in the mesh
- description: spacing of the grid points along each dimension (in the
units of the simulation); this refers to the spacing of the
actual record that is written to the file, not that of the
Expand All @@ -403,7 +403,7 @@ meshes):

- `gridGlobalOffset`
- type: 1-dimensional array containing N *(float64 / REAL8)*
elements, where N is the number of dimensions in the simulation
elements, where N is the number of dimensions in the mesh
- description: start of the current domain of the simulation (position of
the beginning of the first cell) in simulation units
- advice to implementors: the order of the N values must be identical to
Expand All @@ -416,7 +416,7 @@ on Unit Systems and Dimensionality, further below):

- `gridUnitSI`
- type: 1-dimensional array containing N *(float64 / REAL8)*
elements, where N is the number of dimensions in the simulation.
elements, where N is the number of dimensions in the mesh.
The order of the N values must be identical to the axes in `axisLabels`.
- description: unit-conversion factor to multiply each value in
`gridSpacing` and `gridGlobalOffset`, in order to convert
Expand All @@ -425,7 +425,7 @@ on Unit Systems and Dimensionality, further below):

- `gridUnitDimension`
- type: 1-dimensional array of 7 N *(float64 / REAL8)*
elements, where N is the number of dimensions in the simulation.
elements, where N is the number of dimensions in the mesh.
The order of the N 7-value arrays must be identical to the axes in `axisLabels`.
- description: powers of the 7 base measures characterizing the
grid axes's dimensions (length L, mass M, time T,
Expand All @@ -447,7 +447,7 @@ The following attributes must be stored with each `scalar record` and each

- `position`
- type: 1-dimensional array of N *(floatX)* where N is the number of
dimensions in the simulation.
dimensions in the mesh.
- range of each value: `[ 0.0 : 1.0 )`
- description: relative position of the component on the current element of
the mesh/grid/node/cell/voxel;
Expand Down Expand Up @@ -754,6 +754,8 @@ defined:
see [EXT_BeamPhysics.md](EXT_BeamPhysics.md).
- **ED-PIC**: electro-dynamic/static particle-in-cell codes,
see [EXT_ED-PIC.md](EXT_ED-PIC.md).
- **MeshRefinement**: mesh records refined over multiple levels of resolution,
see [EXT_MeshRefinement.md](EXT_MeshRefinement.md)
- **ParticleWeighting**: conventions for macroparticles,
see [EXT_ParticleWeighting.md](EXT_ParticleWeighting.md).
- **SpeciesType**: naming lists for particle species,
Expand Down