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

A convenience wrapper for accessing the distribution function coefficients over the device on each vertex. Note that odd-order expansion coefficients are averaged, thus one MUST NOT evaluate flux-quantities using this interpolated wrapper! More...

#include <df_wrappers.hpp>

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

Public Member Functions
	interpolated_she_df_wrapper (DeviceType const &device, viennashe::config const &conf, SHEQuantityT const &quan)
double	operator() (CellType const &cell, double kinetic_energy, std::size_t l, long m, std::size_t index_H_guess=0) const
	Returns the energy distribution function for the respective carrier type 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::interpolated_she_df_wrapper< DeviceType, SHEQuantityT >

A convenience wrapper for accessing the distribution function coefficients over the device on each vertex. Note that odd-order expansion coefficients are averaged, thus one MUST NOT evaluate flux-quantities using this interpolated wrapper!

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 279 of file df_wrappers.hpp.

Member Typedef Documentation

dispersion_relation_type

template<typename DeviceType , typename SHEQuantityT >

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

Definition at line 291 of file df_wrappers.hpp.

self_type

template<typename DeviceType , typename SHEQuantityT >

typedef interpolated_she_df_wrapper viennashe::she::interpolated_she_df_wrapper< DeviceType, SHEQuantityT >::self_type

Definition at line 289 of file df_wrappers.hpp.

she_quantity_type

template<typename DeviceType , typename SHEQuantityT >

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

Definition at line 292 of file df_wrappers.hpp.

Constructor & Destructor Documentation

interpolated_she_df_wrapper()

template<typename DeviceType , typename SHEQuantityT >

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

inline

Definition at line 294 of file df_wrappers.hpp.

Member Function Documentation

dispersion_relation()

template<typename DeviceType , typename SHEQuantityT >

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

inline

Definition at line 323 of file df_wrappers.hpp.

operator()()

template<typename DeviceType , typename SHEQuantityT >

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

inline

Returns the energy distribution function for the respective carrier type in one valley on a vertex:

Parameters

cell	The cell from which the SHE coefficient should be returned
kinetic_energy	Kinetic energy
l	Major (leading) spherical harmonics index
m	Minor spherical harmonics index
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 308 of file df_wrappers.hpp.

quan()

template<typename DeviceType , typename SHEQuantityT >

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

inline

Definition at line 321 of file df_wrappers.hpp.

---

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

• viennashe/she/df_wrappers.hpp