Debian Codegraph @

externals/OPTIMADE/schemas/src/defs/v1.2/properties/optimade/structures/elements.yaml

raw
1 $$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition"
2 $id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/elements"
3 title: "elements"
4 x-optimade-type: "list"
5 x-optimade-definition:
6 label: "elements_optimade_structures"
7 kind: "property"
8 version: "1.2.0"
9 format: "1.2"
10 name: "elements"
11 x-optimade-dimensions:
12 names: ["dim_elements"]
13 type:
14 - "array"
15 - "null"
16 description: |-
17 The chemical symbols of the different elements present in the structure.
18
19 **Requirements/Conventions**:
20
21 - The strings are the chemical symbols, i.e., either a single uppercase letter or an uppercase letter followed by a number of lowercase letters.
22 - The order MUST be alphabetical.
23 - MUST refer to the same elements in the same order, and therefore be of the same length, as `elements_ratios`, if the latter is provided.
24 - Note: This property SHOULD NOT contain the string "X" to indicate non-chemical elements or "vacancy" to indicate vacancies (in contrast to the field `chemical_symbols` for the species property).
25
26 **Query examples**:
27
28 - A filter that matches all records of structures that contain Si, Al **and** O, and possibly other elements: `elements HAS ALL "Si", "Al", "O"`.
29 - To match structures with exactly these three elements, use `elements HAS ALL "Si", "Al", "O" AND elements LENGTH 3`.
30 - Note: length queries on this property can be equivalently formulated by filtering on the `nelements` property directly.
31 examples:
32 - ['Al', 'Si', 'O']
33 - ['He']
34 x-optimade-unit: "inapplicable"
35 items:
36 $$inherit: "/v1.2/properties/optimade/common/element"