Skip to content
Closed
Show file tree
Hide file tree
Changes from 4 commits
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
90 changes: 90 additions & 0 deletions EXT_SpeciesType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
Convention for Specifying Particle Species
==========================================

openPMD extension name: `SpeciesType`

openPMD extension ID: `4`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: this will be removed in 2.0.0 but we have to assign it since we are still in 1.X



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

This convention is for standardizing the names of particle species, e.g. in
particle physics.


Additional Record Attribute
---------------------------

The following additional attribute for openPMD `records` is defined in this
extension:

- `SpeciesType`
- type: *(string)*
- scope: *optional*
- description: particle species in this record. If there are multiple
species to be specified, they can be specified using a
semicolon separated list.
- allowed values:
- *see the lists below* and additionally
- `other` if none of the ones below applies, user are free to append a
free text after a colon, e.g. `other:neutralino` or `other:cherry`
- examples:
- `electron` (e.g. on an electron `particle record` or an electron
density `mesh record`)
- `electron;proton;#12C` (e.g. on a `mesh record` for a plasma's
local charge density)
- `other:apple;other:orange` (for a `record` mixing apples & oranges)

This attribute can be used with any `record` (including `mesh records`).

### SubAtomic Particles

- `subatomic:antimuon`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

offline discussion: we won't collide (yet) and if we should later one we can still add prefixes and convert known ones.

- `subatomic:antiproton`
- `subatomic:bottom`
- `subatomic:charm-antiquark`
- `subatomic:charm-quark`
- `subatomic:deuteron`
- `subatomic:down-antiquark`
- `subatomic:down-quark`
- `subatomic:electron`
- `subatomic:electron-neutrino`
- `subatomic:gluon`
- `subatomic:graviton`
- `subatomic:higgs-boson`
- `subatomic:muon`
- `subatomic:muon-neutrino`
- `subatomic:neutron`
- `subatomic:photon`
- `subatomic:pion`
- `subatomic:positron`
- `subatomic:proton`
- `subatomic:strange-antiquark`
- `subatomic:strange-quark`
- `subatomic:tao-antiquark`
- `subatomic:tao-quark`
- `subatomic:tao-neutrino`
- `subatomic:top-antiquark`
- `subatomic:top-quark`
- `subatomic:up-antiquark`
- `subatomic:up-quark`
- `subatomic:w-boson`
- `subatomic:z-boson`

### Atoms & Isotopes

Element namings follow the abbreviated namings of the periodic table, defined
by *The International Union of Pure and Applied Chemistry* (IUPAC).
They are prefixed with `element:`, e.g. `element:Si`.

Closer specifications of isotopes are denoted by a `isotope:` prefix followed
by the isotopic number followed by the chemical symbol, e.g.: `isotope:3He`
for Helium-3.

Charge states shall not be specified here but rather in `attributes`
(`mesh record`) or `records` or a `particle species`.

Copy link
Member

@ax3l ax3l Feb 1, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention that the most abundant isotope can just be short-handed as He (for #4He)? It's somehow missing, but would allow ambiguity.

Is D ok for #2H or shall it be forced to the latter?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say that the standard should assume that "He" is equivalent to "#4He".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deuterium would be "#2H"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

excellent, so we keep the abbreviations to a minimum: regular elements in the IUPAC periodic table

### Molecules

Use standard chemical notation with a `molecule:` prefix, e.g.: `molecule:H20`.
2 changes: 2 additions & 0 deletions STANDARD.md
Original file line number Diff line number Diff line change
Expand Up @@ -730,6 +730,8 @@ defined:

- **ED-PIC**: electro-dynamic/static particle-in-cell codes,
see [EXT_ED-PIC.md](EXT_ED-PIC.md).
- **SpeciesType**: naming lists for particle species,
see [EXT_SpeciesType.md](EXT_SpeciesType.md).

Extensions to similar domains such as fluid, finite-element or
molecular-dynamics simulations, CCD images or other particle and/or mesh-based
Expand Down