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
clearRemove all items from the dict.
copyReturn a shallow copy of the dict.
fromkeysCreate a new dictionary with keys from iterable and values set to value.
getReturn the value for key if key is in the dictionary, else default.
itemsReturn a set-like object providing a view on the dict's items.
keysReturn a set-like object providing a view on the dict's keys.
popIf the key is not found, return the default if given; otherwise, raise a KeyError.
popitemRemove and return a (key, value) pair as a 2-tuple.
setdefaultInsert key with a value of default if key is not in the dictionary.
updateIf 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]
valuesReturn an object providing a view on the dict's values.
Attributes
totalstandard 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.