viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT > Class Template Reference

A convenience wrapper for accessing the generalized energy distribution function (f * Z, with density of states Z) on each vertex of the device. More...

#include <df_wrappers.hpp>

Public Types
typedef viennashe::config::dispersion_relation_type	dispersion_relation_type
typedef SHEQuantityT	she_quantity_type

Public Member Functions
	generalized_edf_wrapper (viennashe::config const &conf, SHEQuantityT const &quan)
	Constructs the wrapper. More...
double	operator() (CellType const &cell, double kinetic_energy, std::size_t index_H_guess=0) const
	Returns the energy distribution function for electrons in one valley on a vertex: More...
SHEQuantityT const &	quan () const
dispersion_relation_type const &	dispersion_relation () const

Detailed Description

template<typename DeviceType, typename SHEQuantityT>
class viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >

A convenience wrapper for accessing the generalized energy distribution function (f * Z, with density of states Z) on each vertex of the device.

Template Parameters

DeviceType	The device type on which to evaluate the distribution function
VectorType	Vector type used for the SHE result vector.

Definition at line 571 of file df_wrappers.hpp.

Member Typedef Documentation

dispersion_relation_type

template<typename DeviceType , typename SHEQuantityT >

typedef viennashe::config::dispersion_relation_type viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >::dispersion_relation_type

Definition at line 582 of file df_wrappers.hpp.

she_quantity_type

template<typename DeviceType , typename SHEQuantityT >

typedef SHEQuantityT viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >::she_quantity_type

Definition at line 583 of file df_wrappers.hpp.

Constructor & Destructor Documentation

generalized_edf_wrapper()

template<typename DeviceType , typename SHEQuantityT >

viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >::generalized_edf_wrapper ( viennashe::config const &  conf, SHEQuantityT const &  quan  )

inline

Constructs the wrapper.

Parameters

quan	The SHE quantities
conf	The simulator configuration

Definition at line 590 of file df_wrappers.hpp.

Member Function Documentation

dispersion_relation()

template<typename DeviceType , typename SHEQuantityT >

dispersion_relation_type const & viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >::dispersion_relation ( ) const

inline

Definition at line 610 of file df_wrappers.hpp.

operator()()

template<typename DeviceType , typename SHEQuantityT >

double viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >::operator() ( CellType const &  cell, double  kinetic_energy, std::size_t  index_H_guess = 0  ) const

inline

Returns the energy distribution function for electrons in one valley on a vertex:

Parameters

cell	The cell from which the SHE coefficient should be returned
kinetic_energy	Kinetic energy
index_H_guess	The total energy index for starting the search for the best total energy index available. Allows to speed-up evaluation considerably.

Definition at line 601 of file df_wrappers.hpp.

quan()

template<typename DeviceType , typename SHEQuantityT >

SHEQuantityT const & viennashe::she::generalized_edf_wrapper< DeviceType, SHEQuantityT >::quan ( ) const

inline

Definition at line 608 of file df_wrappers.hpp.

---

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

• viennashe/she/df_wrappers.hpp