ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
Public Types | Public Member Functions | List of all members
viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT > Class Template Reference

Common representation of any quantity associated with two objects of a certain type and an index. More...

#include <she_quantity.hpp>

Public Types

typedef ValueT value_type
 

Public Member Functions

 const_she_quantity (unknown_she_quantity< AssociatedT1, AssociatedT2 > const &quan)
 
ValueT const * get_values (AssociatedT1 const &elem, std::size_t index_H) const
 
ValueT const * get_values (AssociatedT2 const &elem, std::size_t index_H) const
 
short get_expansion_order (AssociatedT1 const &elem, std::size_t index_H) const
 
short get_expansion_order (AssociatedT2 const &elem, std::size_t index_H) const
 
short get_unknown_num (AssociatedT1 const &elem, std::size_t index_H) const
 
short get_unknown_num (AssociatedT2 const &elem, std::size_t index_H) const
 
ValueT operator() (AssociatedT1 const &elem, std::size_t index_H) const
 
ValueT operator() (AssociatedT2 const &elem, std::size_t index_H) const
 
std::string name () const
 

Detailed Description

template<typename AssociatedT1, typename AssociatedT2, typename ValueT = double>
class viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >

Common representation of any quantity associated with two objects of a certain type and an index.

Definition at line 272 of file she_quantity.hpp.

Member Typedef Documentation

◆ value_type

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
typedef ValueT viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::value_type

Definition at line 278 of file she_quantity.hpp.

Constructor & Destructor Documentation

◆ const_she_quantity()

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::const_she_quantity ( unknown_she_quantity< AssociatedT1, AssociatedT2 > const &  quan)
inline

Definition at line 280 of file she_quantity.hpp.

Member Function Documentation

◆ get_expansion_order() [1/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
short viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::get_expansion_order ( AssociatedT1 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 291 of file she_quantity.hpp.

◆ get_expansion_order() [2/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
short viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::get_expansion_order ( AssociatedT2 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 292 of file she_quantity.hpp.

◆ get_unknown_num() [1/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
short viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::get_unknown_num ( AssociatedT1 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 294 of file she_quantity.hpp.

◆ get_unknown_num() [2/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
short viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::get_unknown_num ( AssociatedT2 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 295 of file she_quantity.hpp.

◆ get_values() [1/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
ValueT const * viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::get_values ( AssociatedT1 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 288 of file she_quantity.hpp.

◆ get_values() [2/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
ValueT const * viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::get_values ( AssociatedT2 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 289 of file she_quantity.hpp.

◆ name()

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
std::string viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::name ( ) const
inline

Definition at line 300 of file she_quantity.hpp.

◆ operator()() [1/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
ValueT viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::operator() ( AssociatedT1 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 297 of file she_quantity.hpp.

◆ operator()() [2/2]

template<typename AssociatedT1 , typename AssociatedT2 , typename ValueT = double>
ValueT viennashe::she::const_she_quantity< AssociatedT1, AssociatedT2, ValueT >::operator() ( AssociatedT2 const &  elem,
std::size_t  index_H 
) const
inline

Definition at line 298 of file she_quantity.hpp.

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