httk.atomistic.species_class¶

Backend wrapping a Species in the class representation.

Classes¶

Backend for a species backed by an actual Species object.

Module Contents¶

class httk.atomistic.species_class.SpeciesClass(obj: httk.atomistic.species.Species, **hints: Any)[source]¶

Bases: httk.atomistic.species_backend.SpeciesBackend

Backend for a species backed by an actual Species object.

Its accessors delegate to the wrapped Species, and unwrap returns that Species.

property name: str[source]¶

property chemical_symbols: tuple[str, Ellipsis][source]¶

property concentration: tuple[float, Ellipsis][source]¶

property mass: tuple[float, Ellipsis] | None[source]¶

property attached: tuple[str, Ellipsis] | None[source]¶

property nattached: tuple[int, Ellipsis] | None[source]¶

property original_name: str | None[source]¶

unwrap() → Any[source]¶: Return the most raw representation possible of this backend, i.e., if it uses a backend with an internal representaion - or if it can (possibly lossly) convert itself into a more raw representation that still would be recognized as a <Something>Like type, that representation will be returned. If this is not possible, the instance itself is returned.