Debian Codegraph @

externals/OPTIMADE/schemas/src/defs/v1.2/properties/optimade/structures/elements_ratios.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_ratios"
3 title: "elements ratios"
4 x-optimade-type: "list"
5 x-optimade-definition:
6 label: "elements_ratios_optimade_structures"
7 kind: "property"
8 version: "1.2.0"
9 format: "1.2"
10 name: "elements_ratios"
11 x-optimade-dimensions:
12 names: ["dim_elements"]
13 type:
14 - "array"
15 - "null"
16 description: |-
17 Relative proportions of different elements in the structure.
18
19 **Requirements/Conventions**:
20
21 - Composed by the proportions of elements in the structure as a list of floating point numbers.
22 - The sum of the numbers MUST be 1.0 (within floating point accuracy)
23 - MUST refer to the same elements in the same order, and therefore be of the same length, as `elements`, if the latter is provided.
24
25 **Query examples**:
26
27 - Note: Useful filters can be formulated using the set operator syntax for correlated values.
28 However, since the values are floating point values, the use of equality comparisons is generally inadvisable.
29 - OPTIONAL: a filter that matches structures where approximately 1/3 of the atoms in the structure are the element Al is: `elements:elements_ratios HAS ALL "Al":>0.3333, "Al":<0.3334`.
30 examples:
31 - [1.0]
32 - [0.3333333333333333, 0.2222222222222222, 0.4444444444444444]
33 x-optimade-unit: "inapplicable"
34 items:
35 x-optimade-type: "float"
36 type:
37 - "number"
38 x-optimade-unit: "dimensionless"
39 minimum: 0.0
40 maximum: 1.0