Package schrodinger :: Package application :: Package matsci :: Package espresso :: Module qeoutput :: Class PDOS
[hide private]
[frames] | no frames]

Class PDOS

object --+
         |
        PDOS

Class that holds partial DOS (PDOS) data. Call getPDOS to get broadened data.

Instance Methods [hide private]
 
__init__(self, proj, wfc_types, efermi, band)
Initialize PDOS object.
 
getPDOS(self, degauss, delta_e=0.01)
Calculate PDOS and set in self.pdos.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
dict
_getPDOSDict(is_spin_polarized, nsteps)
Get an empty dictionary with correct number of spin keys and arrays for PDOS data.
Class Variables [hide private]
  NUM_IDX = 5
  ADOS_IDX = 1
  AIDOS_IDX = 3
hash(x)
  ALDOS_IDX = 4
  EDOS_IDX = 2
  LDOS_IDX = 0
hash(x)
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, proj, wfc_types, efermi, band)
(Constructor)

 

Initialize PDOS object. Constructor only assigns values, call getPDOS for broadening.

Parameters:
  • proj (dict of 3d numpy.array) - Dict with SPIN_UP, SPIN_DW (optional) keys, each containing a 3D array containing: index of projected atom wavefunction, index of k-point, index of band and WFC projection as value.
  • wfc_types (list of WfcType) - List containing wavefunction types description
  • efermi (float) - Fermi energy in eV
  • band (BandStructure)
Overrides: object.__init__

_getPDOSDict(is_spin_polarized, nsteps)
Static Method

 

Get an empty dictionary with correct number of spin keys and arrays for PDOS data.

Parameters:
  • nsteps (int) - 1D grid size
  • is_spin_polarized (bool)
Returns: dict
Dictionary to hold PDOS data

getPDOS(self, degauss, delta_e=0.01)

 

Calculate PDOS and set in self.pdos.

Parameters:
  • degauss (float) - Broadening (eV) for computing PDOS
  • delta_e (float) - Energy grid spacing eV