CoefficientPhonon¶
-
class
sisl.physics.phonon.
CoefficientPhonon
(c, parent=None, **info)[source]¶ Coefficients describing some physical quantity related to phonons
Attributes
c
dkind
The data-type of the coefficient (in str) dtype
Data-type for the coefficients info
parent
shape
Returns the shape of the coefficients Methods
__init__
(c[, parent])Initialize self. copy
()Return a copy (only the coefficients are copied). degenerate
(eps)Find degenerate coefficients with a specified precision iter
([asarray])An iterator looping over the coefficients in this system sub
(idx)Return a new coefficient with only the specified coefficients -
c
¶
-
copy
()¶ Return a copy (only the coefficients are copied).
parent
andinfo
are passed by reference
-
degenerate
(eps)¶ Find degenerate coefficients with a specified precision
Parameters: - eps : float
the precision above which coefficients are not considered degenerate
Returns: - list of numpy.ndarray: a list of indices
-
dkind
¶ The data-type of the coefficient (in str)
-
dtype
¶ Data-type for the coefficients
-
info
¶
-
iter
(asarray=False)¶ An iterator looping over the coefficients in this system
Parameters: - asarray: bool, optional
if true the yielded values are the coefficient vectors, i.e. a numpy array. Otherwise an equivalent object is yielded.
Yields: - coeff: Coefficent
the current coefficent as an object, only returned if asarray is false.
- coeff: numpy.ndarray
the current the coefficient as an array, only returned if asarray is true.
-
parent
¶
-
shape
¶ Returns the shape of the coefficients
-
sub
(idx)¶ Return a new coefficient with only the specified coefficients
Parameters: - idx : int or array_like
indices that are retained in the returned object
Returns: - Coefficient
a new coefficient only containing the requested elements
-