Base: Correlate Mesh & Particle Groups

[ax3l]

Description

This allows to add an optional attribute to particle groups and mesh records to cross-correlate projections and probes.

Implements issue: #238

Affected Components

• base

Logic Changes

TODO: (write this)

Writer Changes

None

Reader Changes

TODO: (write this)

What would a reader need to change? Link implementation examples!

• openPMD-validator:
• openPMD-viewer:
• VisualPIC: https://github.com/AngelFP/VisualPIC
• yt: none
• VisIt: none
• converter: none
• openPMD-api: none

Data Updater

None

[AngelFP]

Thanks for this nice addition, @ax3l . This would definitely simply some things in VisualPIC!

I have one question though: the implementation here works well to link mesh records to particle groups, but this means that both have to exist. However, it can happen sometimes that, for example, the simulation output contains the charge density field associated to a particle species, but does not contain the species itself as particle group. In this case, the mesh is therefore not linked to a particle group, but simply to a species in the simulation. Would this be a problem here?

[ax3l]

That's a good point. I think we can add a note for implementers to clarify.

It's still really useful to reference a particle group name for meshes like <species>_chargeDensity, even if the particle output is disabled for an openPMD series.

[AngelFP]

Looks good, thanks a lot!

It's still really useful to reference a particle group name for meshes like <species>_chargeDensity, even if the particle output is disabled for an openPMD series.

That's also a nice convention. I'll keep it in mind for when I have to implement it in Wake-T.