Debian Codegraph @

externals/OPTIMADE/schemas/src/defs/v1.2/properties/optimade/structures/lattice_vectors.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/lattice_vectors"
3 title: "lattice vectors"
4 x-optimade-definition:
5 label: "lattice_vectors_optimade_structures"
6 kind: "property"
7 version: "1.2.1"
8 format: "1.2"
9 name: "lattice_vectors"
10 x-optimade-type: "list"
11 x-optimade-dimensions:
12 names: ["dim_lattice", "dim_spatial"]
13 sizes: [3, 3]
14 x-optimade-unit-definitions:
15 - $$inherit: "/v1.2/units/si/general/angstrom"
16 type:
17 - "array"
18 - "null"
19 description: |-
20 The three lattice vectors in Cartesian coordinates, in ångström (Å).
21
22 **Requirements/Conventions**:
23
24 - MUST be a list of three vectors *a*, *b*, and *c*, where each of the vectors MUST BE a list of the vector's coordinates along the x, y, and z Cartesian coordinates.
25 (Therefore, the first index runs over the three lattice vectors and the second index runs over the x, y, z Cartesian coordinates).
26 - For databases that do not define an absolute Cartesian system (e.g., only defining the length and angles between vectors), the first lattice vector SHOULD be set along *x* and the second on the *xy*-plane.
27 - MUST always contain three vectors of three coordinates each, independently of the elements of property `dimension_types`.
28 The vectors SHOULD by convention be chosen so the determinant of the `lattice_vectors` matrix is different from zero.
29 The vectors in the non-periodic directions have no significance beyond fulfilling these requirements.
30 - The coordinates of the lattice vectors of non-periodic dimensions (i.e., those dimensions for which `dimension_types` is `0`) MAY be given as a list of all `null` values.
31 If a lattice vector contains the value `null`, all coordinates of that lattice vector MUST be `null`.
32
33 **Explained examples**:
34
35 - `[[4.0,0.0,0.0],[0.0,4.0,0.0],[0.0,1.0,4.0]]` represents a cell, where the first vector is (4, 0, 0), i.e., a vector aligned along the x axis of length 4 Å; the second vector is (0, 4, 0); and the third vector is (0, 1, 4).
36 examples:
37 - [[4.0,0.0,0.0],[0.0,4.0,0.0],[0.0,1.0,4.0]]
38 x-optimade-unit: "inapplicable"
39 items:
40 x-optimade-type: "list"
41 x-optimade-dimensions:
42 names: ["dim_spatial"]
43 sizes: [3]
44 type:
45 - "array"
46 x-optimade-unit: "inapplicable"
47 items:
48 x-optimade-type: "float"
49 type:
50 - "number"
51 x-optimade-unit: "angstrom"