stko.PositionedAtom

class stko.PositionedAtom(atom, position)[source]

Bases: object

A container for stk.Atom and a coordinate.

Parameters:
  • atom (Atom) – The atom.

  • position (tuple[float, ...]) – The position (x, y, z) of the atom in cartesian coordinates.

Methods

clone

Return a clone.

get_atom

get_atomic_number

get_charge

get_id

get_position

with_id

Get a clone but with a different id.

clone()[source]

Return a clone.

Returns:

The clone. It has the same type as the original atom.

Return type:

Self

get_atom()[source]
Return type:

Atom

get_atomic_number()[source]
Return type:

int

get_charge()[source]
Return type:

int

get_id()[source]
Return type:

int

get_position()[source]
Return type:

tuple[float, …]

with_id(id)[source]

Get a clone but with a different id.

Returns:

A clone with a new id. Has the same type as the original atom.

Parameters:

id (int)

Return type:

Self