Debian Codegraph @

externals/OPTIMADE/schemas/src/defs/v1.3/properties/optimade/structures/fractional_site_positions.yaml

raw
1 $$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition"
2 $id: "https://schemas.optimade.org/defs/v1.3/properties/optimade/structures/fractional_site_positions"
3 title: "Fractional site positions"
4 x-optimade-type: "list"
5 x-optimade-definition:
6 label: "fractional_site_positions_optimade_structures"
7 kind: "property"
8 version: "1.3.0"
9 format: "1.2"
10 name: "fractional_site_positions"
11 x-optimade-dimensions:
12 names: ["dim_sites", "dim_spatial"]
13 sizes: [null, 3]
14 type:
15 - "array"
16 - "null"
17 description: |-
18 Fractional coordinates (positions) of each site in the structure.
19
20 A site is usually used to describe positions of atoms; what atoms can be encountered at a given site is conveyed by the `species_at_sites` property, and the species themselves are described in the `species` property.
21 Site coordinates MAY be given as `cartesian_site_positions`, `fractional_site_positions`, or both.
22 When symmetry operations given in `space_group_symmetry_operations_xyz` are applied, they MUST be applied to coordinates given in the `fractional_site_positions` array.
23
24 **Requirements/Conventions**:
25
26 - It MUST be a list of length equal to the number of sites in the structure, where every element is a list of the three fractional coordinates of a site expressed as float values in the fractions of the unit cell vectors given by the `lattice_vectors` property.
27 - An entry MAY have multiple sites at the same site position (for a relevant use of this, see e.g., the property `assemblies`).
28 - Since both `cartesian_site_positions` and the `fractional_site_positions` always describe the same sites, they MUST always have the same number of elements, equal to the number of elements in the `species_at_sites` array.
29
30 **Explained examples**:
31
32 - `[[0,0,0],[0,0,0.2]]` indicates a structure with two sites, one sitting at the origin and one along the third unit cell axis (*c*-axis), 1/5-th (0.2) of the vector *c* in the direction of the vector *c* from the origin.
33 examples:
34 - [[0,0,0],[0,0,0.2]]
35 x-optimade-unit: "inapplicable"
36 items:
37 x-optimade-type: "list"
38 x-optimade-dimensions:
39 names: ["dim_spatial"]
40 sizes: [3]
41 type:
42 - "array"
43 x-optimade-unit: "inapplicable"
44 items:
45 x-optimade-type: "float"
46 type:
47 - "number"
48 x-optimade-unit: "dimensionless"