qimpy.Energy

class Energy(name='E')

Bases: dict[str, float | Tensor]

Energy of system with access to components

Parameters:

name (str)

__init__(name='E')

Parameters:

name (str)

Return type:

None

Methods

__init__
clear	D.clear() -> None.
copy	D.copy() -> a shallow copy of D
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	D.items() -> a set-like object providing a view on D's items
keys	D.keys() -> a set-like object providing a view on D's keys
pop	D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
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	D.update([E, ]**F) -> None.
values	D.values() -> an object providing a view on D's values

Attributes

name	standard label for (free) energy type, e.g., E, A, Phi etc.

name: str

standard label for (free) energy type, e.g., E, A, Phi etc.