ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
viennashe::she::current_density_wrapper< DeviceType, SHEQuantity > Class Template Reference

Accessor class providing the carrier velocity inside the device. More...

#include <current_density.hpp>

Public Types

typedef std::vector< double > value_type
 
typedef viennagrid::result_of::cell< MeshType >::type cell_type
 
typedef viennagrid::result_of::facet< MeshType >::type facet_type
 

Public Member Functions

 current_density_wrapper (DeviceType const &device, viennashe::config const &conf, SHEQuantity const &quan)
 
 current_density_wrapper (current_density_wrapper const &o)
 
double operator() (facet_type const &facet) const
 Functor interface returning the current density magnitude on the facet. More...
 
value_type operator() (cell_type const &cell) const
 Functor interface returning the current density at the provided cell. More...
 

Protected Types

typedef DeviceType::mesh_type MeshType
 
typedef viennagrid::result_of::point< MeshType >::type PointType
 

Detailed Description

template<typename DeviceType, typename SHEQuantity>
class viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >

Accessor class providing the carrier velocity inside the device.

Definition at line 174 of file current_density.hpp.

Member Typedef Documentation

◆ cell_type

template<typename DeviceType , typename SHEQuantity >
typedef viennagrid::result_of::cell<MeshType>::type viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::cell_type

Definition at line 182 of file current_density.hpp.

◆ facet_type

template<typename DeviceType , typename SHEQuantity >
typedef viennagrid::result_of::facet<MeshType>::type viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::facet_type

Definition at line 183 of file current_density.hpp.

◆ MeshType

template<typename DeviceType , typename SHEQuantity >
typedef DeviceType::mesh_type viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::MeshType
protected

Definition at line 177 of file current_density.hpp.

◆ PointType

template<typename DeviceType , typename SHEQuantity >
typedef viennagrid::result_of::point<MeshType>::type viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::PointType
protected

Definition at line 178 of file current_density.hpp.

◆ value_type

template<typename DeviceType , typename SHEQuantity >
typedef std::vector<double> viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::value_type

Definition at line 181 of file current_density.hpp.

Constructor & Destructor Documentation

◆ current_density_wrapper() [1/2]

template<typename DeviceType , typename SHEQuantity >
viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::current_density_wrapper ( DeviceType const &  device,
viennashe::config const &  conf,
SHEQuantity const &  quan 
)
inline

Definition at line 185 of file current_density.hpp.

◆ current_density_wrapper() [2/2]

template<typename DeviceType , typename SHEQuantity >
viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::current_density_wrapper ( current_density_wrapper< DeviceType, SHEQuantity > const &  o)
inline

Definition at line 191 of file current_density.hpp.

Member Function Documentation

◆ operator()() [1/2]

template<typename DeviceType , typename SHEQuantity >
value_type viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::operator() ( cell_type const &  cell) const
inline

Functor interface returning the current density at the provided cell.

Definition at line 201 of file current_density.hpp.

◆ operator()() [2/2]

template<typename DeviceType , typename SHEQuantity >
double viennashe::she::current_density_wrapper< DeviceType, SHEQuantity >::operator() ( facet_type const &  facet) const
inline

Functor interface returning the current density magnitude on the facet.

Definition at line 195 of file current_density.hpp.


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