Add particlePatches to JSON schema

Author: franzpoeschel

share/openPMD/json_schema/particle_patches.toml

@@ -0,0 +1,44 @@
+type = "object"
+title = "Particle Patches"
+description = "Recommended group for post-processing. It logically orders the 1D arrays of attributes into local patches of particles that can be read and processed in parallel."
+
+################################
+# General layout of attributes #
+################################
+
+[properties.attributes]
+title = "Attribute layout"
+description = "Custom attributes allowed, no required attributes defined."
+"$ref" = "attributes.json"
+
+#######################################################
+# Definition of particle patches via                  #
+# numParticles, numParticlesOffset, offset and extent #
+#######################################################
+
+[properties.numParticles]
+title = "numParticles"
+description = "number of particles in this patch"
+
+# todo: INT type dataset
+"$ref" = "record_component.json"
+
+
+[properties.numParticlesOffset]
+title = "numParticles"
+description = "offset within the one-dimensional records of the particle species where the first particle in this patch is stored"
+
+# todo: INT type dataset
+"$ref" = "record_component.json"
+
+
+[properties.offset]
+title = "Offset"
+description = "absolute position (position + positionOffset as defined above) where the particle patch begins: defines the (inclusive) lower bound with positions that are associated with the patch; the same requirements as for regular record components apply"
+"$ref" = "patch_record.json"
+
+
+[properties.extent]
+title = "Extent"
+description = "extent of the particle patch; the offset + extent must be larger than the maximum absolute position of particles in the patch as the exact upper bound of position offset + extent is excluded from the patch; the same requirements as for regular record components apply"
+"$ref" = "patch_record.json"

share/openPMD/json_schema/particle_species.toml

@@ -27,6 +27,10 @@ title = "Attribute layout"
 description = "Custom attributes allowed, no required attributes defined."
 "$ref" = "attributes.json"
 
+[properties.particlePatches]
+title = "Particle Patches"
+"$ref" = "particle_patches.json"
+
 
 [patternProperties."^(?!(attributes|particlePatches)).*"]
 title = "Record"

share/openPMD/json_schema/patch_record.toml

@@ -0,0 +1,37 @@
+#########################################################
+# Requirement 1: Mesh-specific structure and attributes #
+#########################################################
+
+[[allOf]]
+
+type = "object"
+required = ["attributes"]
+title = "Record"
+description = "A list of particle quantities."
+
+##############################################
+# Requirement 1: Generic attribute structure #
+##############################################
+
+
+[allOf.properties.attributes]
+title = "Attribute layout"
+"$ref" = "attributes.json"
+
+#######################################################
+# Requirement 2: Contains components of a vector mesh #
+#######################################################
+
+[[allOf]]
+title = "Contains vector components"
+description = "Additionally to the attributes, at least one component must be contained"
+# The attributes are contained in this dict, and at least one further
+# non-scalar component. Hence, we require at least two entries.
+minProperties = 2
+propertyNames.pattern = "^\\w*$"
+
+[allOf.patternProperties]
+
+[allOf.patternProperties."^(?!attributes).*"]
+title = "Scalar component"
+"$ref" = "record_component.json"