| 1 |
$$schema: "https://schemas.optimade.org/meta/v1.2/optimade/property_definition" |
| 2 |
$id: "https://schemas.optimade.org/defs/v1.2/properties/optimade/structures/species_at_sites" |
| 3 |
title: "species at sites" |
| 4 |
x-optimade-type: "list" |
| 5 |
x-optimade-definition: |
| 6 |
label: "species_at_sites_optimade_structures" |
| 7 |
kind: "property" |
| 8 |
version: "1.2.0" |
| 9 |
format: "1.2" |
| 10 |
name: "species_at_sites" |
| 11 |
x-optimade-dimensions: |
| 12 |
names: ["dim_sites"] |
| 13 |
type: |
| 14 |
- "array" |
| 15 |
- "null" |
| 16 |
description: |- |
| 17 |
Name of the species at each site (where values for sites are specified with the same order of the property `cartesian_site_positions`). The properties of the species are found in the property `species`. |
| 18 |
|
| 19 |
**Requirements/Conventions**: |
| 20 |
|
| 21 |
- MUST have length equal to the number of sites in the structure (first dimension of the list property `cartesian_site_positions`). |
| 22 |
- Each species name mentioned in the `species_at_sites` list MUST be described in the list property `species` (i.e. for each value in the `species_at_sites` list there MUST exist exactly one dictionary in the `species` list with the `name` attribute equal to the corresponding `species_at_sites` value). |
| 23 |
- Each site MUST be associated only to a single species. |
| 24 |
**Note**: However, species can represent mixtures of atoms, and multiple species MAY be defined for the same chemical element. |
| 25 |
This latter case is useful when different atoms of the same type need to be grouped or distinguished, for instance in simulation codes to assign different initial spin states. |
| 26 |
|
| 27 |
**Explained examples**: |
| 28 |
|
| 29 |
- `["Ti","O2"]` indicates that the first site is hosting a species labeled `"Ti"` and the second a species labeled `"O2"` |
| 30 |
- `["Ac", "Ac", "Ag", "Ir"]` indicates that the first two sites contain the `"Ac"` species, while the third and fourth sites contain the `"Ag"` and `"Ir"` species, respectively. |
| 31 |
examples: |
| 32 |
- ["Ti","O2"] |
| 33 |
- ["Ac", "Ac", "Ag", "Ir"] |
| 34 |
x-optimade-unit: "inapplicable" |
| 35 |
items: |
| 36 |
$$inherit: "/v1.2/properties/optimade/common/species_name" |