qimpy.Energy

class Energy

Bases: dict[str, Union[float, Tensor]]

Energy of system with access to components

__init__(*args, **kwargs)

Methods

__init__
clear
copy
fromkeys	Create a new dictionary with keys from iterable and values set to value.
get	Return the value for key if key is in the dictionary, else default.
items
keys
pop	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem	Remove and return a (key, value) pair as a 2-tuple.
setdefault	Insert key with a value of default if key is not in the dictionary.
sum_tensor
update	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values

Attributes

name	Appropriate name of (free) energy based on components.

property name: str

Appropriate name of (free) energy based on components.