treams._core.PhysicsDict

class treams._core.PhysicsDict(items=(), /, **kwargs)

Physics dictionary.

Derives from treams.util.AnnotationDict. This dictionary has additionally several properties defined.

basis

Basis set.

Type:

BasisSet

k0

Wave number.

Type:

float

kpar

Parallel wave vector components. Usually, this is a list of length 3 with its items corresponding to the Cartesian axes. Unspecified items are set to nan.

Type:

list

lattice

Lattice definition.

Type:

treams.Lattice

material

Material definition.

Type:

treams.Material

modetype

Mode type, for spherical and cylindrical waves this can be “incident” and “scattered”, for partial plane waves it can be “up” or “down”.

Type:

str

poltype

Polarization, see also Polarizations.

Type:

str

__init__(items=(), /, **kwargs)

Initialization.

Methods

__init__([items])	Initialization.
clear()
get(k[,d])
items()
keys()
match(other)	Compare the own keys to another dictionary.
pop(k[,d])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem()	as a 2-tuple; but raise KeyError if D is empty.
setdefault(k[,d])
update([E, ]**F)	If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values()

Attributes

properties

Special properties tracked by the PhysicsDict.