| 1 |
$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" |
| 2 |
$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/nperiodic_dimensions" |
| 3 |
title: "number of periodic dimensions" |
| 4 |
x-optimade-type: "integer" |
| 5 |
x-optimade-definition: |
| 6 |
label: "nperiodic_dimensions_optimade_structures" |
| 7 |
kind: "property" |
| 8 |
version: "1.2.0" |
| 9 |
format: "1.2" |
| 10 |
name: "nperiodic_dimensions" |
| 11 |
type: |
| 12 |
- "integer" |
| 13 |
- "null" |
| 14 |
description: |- |
| 15 |
An integer specifying the number of periodic dimensions in the structure, equivalent to the number of non-zero entries in `dimension_types`. |
| 16 |
|
| 17 |
**Requirements/Conventions**: |
| 18 |
|
| 19 |
- The integer value MUST be between 0 and 3 inclusive and MUST be equal to the sum of the items in the dimension_types property. |
| 20 |
|
| 21 |
- This property only reflects the treatment of the lattice vectors provided for the structure, and not any physical interpretation of the dimensionality of its contents. |
| 22 |
|
| 23 |
**Explained examples** |
| 24 |
|
| 25 |
- `2` should be indicated in cases where dimension_types is any of `[1, 1, 0]`, `[1, 0, 1]`, `[0, 1, 1]`. |
| 26 |
|
| 27 |
**Query examples**: |
| 28 |
|
| 29 |
- Match only structures with exactly 3 periodic dimensions: `nperiodic_dimensions=3` |
| 30 |
- Match all structures with 2 or fewer periodic dimensions: `nperiodic_dimensions<=2` |
| 31 |
examples: |
| 32 |
- 2 |
| 33 |
x-optimade-unit: "dimensionless" |