sisl.physics.phonon.CoefficientPhonon¶

class sisl.physics.phonon.CoefficientPhonon(c, parent=None, **info)[source]¶

Bases: sisl.physics.Coefficient

Coefficients describing some physical quantity related to phonons

Methods

`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`
`dkind`	The data-type of the coefficient (in str)
`dtype`	Data-type for the coefficients
`info`
`parent`
`shape`	Returns the shape of the coefficients

__init__(c, parent=None, **info)¶

c¶

copy()¶: Return a copy (only the coefficients are copied). parent and info 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: a list of indices
Return type: list of numpy.ndarray

property dkind¶: The data-type of the coefficient (in str)

property 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¶

property 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: a new coefficient only containing the requested elements
Return type: Coefficient