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.

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

Base: Correlate Mesh & Particle Groups #243

Merged
merged 2 commits into from
Mar 9, 2021
Merged
Changes from 1 commit
Commits
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
28 changes: 28 additions & 0 deletions STANDARD.md
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,20 @@ The following attributes must be stored with each `scalar record` and each
the same dimensionality N as in `gridSpacing` and
`gridGlobalOffset`

### Optional Attributes for each `mesh record`

- `particleList`
- type: *(string)*
- description:
this adds a hint to analysis tools that this mesh record is related to one or more particle groups;
multiple particle groups can be indicated at the same time and must appear as semicolon-separated list
- note:
this is often used in graphical user-interfaces to group projected meshes of particle distributions in a user-friendly manner;
examples are particle densities and phase space projections
- examples:
ax3l marked this conversation as resolved.
Show resolved Hide resolved
- `electrons`: indicates this field is related to the `particle group` named `electrons`
- `electrons;hydrogen;carbon`: indicates this field is related to the `particle group`s named `electrons`, `hydrogen` and `carbon`


Particle Records
----------------
Expand Down Expand Up @@ -597,6 +611,20 @@ patch order:
`extent` is excluded from the patch;
the same requirements as for regular record components apply

### Optional Attributes for each `Particle Group`

- `meshList`
- type: *(string)*
- description:
this adds a hint to analysis tools that this particle group is related to one or more mesh records;
multiple mesh records can be indicated at the same time and must appear as semicolon-separated list
- note:
this is often used in graphical user-interfaces to group meshes that are sampled with particles in a user-friendly manner;
examples are particle probes as well as non-uniform and curved samples from large meshes
- examples:
ax3l marked this conversation as resolved.
Show resolved Hide resolved
- `E`: indicates this particle group is related to the `E` mesh record
- `E;B;j`: indicates this particle group is related to the `E`, `B` and `j` mesh records


Unit Systems and Dimensionality
-------------------------------
Expand Down