qimpy.Energy

class Energy(name='E')

Bases: dict[str, Tensor]

Energy of system with access to components

Parameters:

name (str)

__init__(name='E')
Parameters:

name (str)

Return type:

None

Methods

__init__

clear

Remove all items from the dict.

copy

Return a shallow copy of the dict.

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

Return a set-like object providing a view on the dict's items.

keys

Return a set-like object providing a view on the dict's 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.

update

If E is present and has a .keys() method, then does: for k in E.keys(): 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

Return an object providing a view on the dict's values.

Attributes

total

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.