ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
viennashe::physics::dispersion_proxy Class Reference

A proxy object for a dispersion relation. Does NOT take ownership of the provided pointer! More...

#include <dispersion.hpp>

Public Member Functions

 dispersion_proxy (dispersion_base const *ptr)
 
double density_of_states (double ekin, double theta=0, double phi=0) const
 Returns the density of states as a function of kinetic energy (and angles, eventually) More...
 
double velocity (double ekin, double theta=0, double phi=0) const
 Returns the velocity as a function of kinetic energy (and angles, eventually) More...
 
double norm_k (double ekin, double theta=0, double phi=0) const
 Returns the norm of the k-vector as a function of energy (and angles, eventually). Not possible for all dispersion relations. More...
 
bool is_isotropic () const
 Returns true if the dispersion relation is isotropic. More...
 
dispersion_base const * get () const
 
double symmetry_factor () const
 

Detailed Description

A proxy object for a dispersion relation. Does NOT take ownership of the provided pointer!

Definition at line 68 of file dispersion.hpp.

Constructor & Destructor Documentation

◆ dispersion_proxy()

viennashe::physics::dispersion_proxy::dispersion_proxy ( dispersion_base const *  ptr)
inline

Definition at line 71 of file dispersion.hpp.

Member Function Documentation

◆ density_of_states()

double viennashe::physics::dispersion_proxy::density_of_states ( double  ekin,
double  theta = 0,
double  phi = 0 
) const
inline

Returns the density of states as a function of kinetic energy (and angles, eventually)

Definition at line 75 of file dispersion.hpp.

◆ get()

dispersion_base const * viennashe::physics::dispersion_proxy::get ( ) const
inline

Definition at line 100 of file dispersion.hpp.

◆ is_isotropic()

bool viennashe::physics::dispersion_proxy::is_isotropic ( ) const
inline

Returns true if the dispersion relation is isotropic.

Definition at line 95 of file dispersion.hpp.

◆ norm_k()

double viennashe::physics::dispersion_proxy::norm_k ( double  ekin,
double  theta = 0,
double  phi = 0 
) const
inline

Returns the norm of the k-vector as a function of energy (and angles, eventually). Not possible for all dispersion relations.

Definition at line 89 of file dispersion.hpp.

◆ symmetry_factor()

double viennashe::physics::dispersion_proxy::symmetry_factor ( ) const
inline

Definition at line 102 of file dispersion.hpp.

◆ velocity()

double viennashe::physics::dispersion_proxy::velocity ( double  ekin,
double  theta = 0,
double  phi = 0 
) const
inline

Returns the velocity as a function of kinetic energy (and angles, eventually)

Definition at line 82 of file dispersion.hpp.


The documentation for this class was generated from the following file: