diff --git a/documentation/source/reference/molecule/adjlist.rst b/documentation/source/reference/molecule/adjlist.rst index a259682a11..7a4980ae07 100644 --- a/documentation/source/reference/molecule/adjlist.rst +++ b/documentation/source/reference/molecule/adjlist.rst @@ -34,8 +34,8 @@ alphanumeric characters and the underscore, as if an identifier in many popular programming languages. However, strictly speaking any non-space ASCII character is allowed. -The subsequent lines may contain keyword-value pairs. Currently there is only -one keyword, ``multiplicity``. +The subsequent lines may contain keyword-value pairs. Currently there can be: +``multiplicity``, ``metal`` and ``facet``. For species or molecule declarations, the value after ``multiplicity`` defines the spin multiplicity of the molecule. E.g. ``multiplicity 1`` for most ground state @@ -44,7 +44,7 @@ and ``multiplicity 3`` for a triplet biradical. If the ``multiplicity`` line is not present then a value of (1 + number of unpaired electrons) is assumed. Thus, it can usually be omitted, but if present can be used to distinguish, -for example, singlet CH2 from triplet CH2. +for example, singlet CH2 from triplet CH2. If defining a Functional :class:`~rmgpy.molecule.Group`, then the value must be a list, which defines the multiplicities that will be matched by the group, eg. @@ -53,6 +53,9 @@ If a wildcard is desired, the line ``'multiplicity x`` can be used instead to ac all multiplicities. If the multiplicity line is omitted altogether, then a wildcard is assumed. +``metal`` and ``facet`` work similarly and will correspond to lines like ``metal Fe``, +``metal [Fe,Cu,Ag]``, ``facet 111``, ``facet [111,211,110]``. + e.g. the following two group adjlists represent identical groups. :: group1 @@ -69,7 +72,7 @@ each subsequent line describes a single atom and its local bond structure. The format of these lines is a whitespace-delimited list with tokens :: - [