ViennaSHE 1.3.0
Free open-source semiconductor device simulator using spherical harmonics expansions techniques.
viennashe::non_const_quantity< AssociatedT, ValueT > Class Template Reference

#include <simulator_quantity.hpp>

Public Types

typedef non_const_quantity< AssociatedT, ValueT > self_type
 
typedef ValueT value_type
 
typedef AssociatedT associated_type
 

Public Member Functions

 non_const_quantity (std::string quan_name, std::size_t num_values, value_type default_value=value_type())
 
 non_const_quantity (std::string quan_name, std::vector< ValueT > const &values_array)
 
 non_const_quantity (self_type const &o)
 
void operator= (self_type const &o)
 
ValueT get_value (associated_type const &elem) const
 
ValueT at (associated_type const &elem) const
 
ValueT operator() (associated_type const &elem) const
 
void set_value (associated_type const &elem, ValueT value)
 
std::string name () const
 

Detailed Description

template<typename AssociatedT, typename ValueT = double>
class viennashe::non_const_quantity< AssociatedT, ValueT >

Definition at line 86 of file simulator_quantity.hpp.

Member Typedef Documentation

◆ associated_type

template<typename AssociatedT , typename ValueT = double>
typedef AssociatedT viennashe::non_const_quantity< AssociatedT, ValueT >::associated_type

Definition at line 92 of file simulator_quantity.hpp.

◆ self_type

template<typename AssociatedT , typename ValueT = double>
typedef non_const_quantity<AssociatedT, ValueT> viennashe::non_const_quantity< AssociatedT, ValueT >::self_type

Definition at line 89 of file simulator_quantity.hpp.

◆ value_type

template<typename AssociatedT , typename ValueT = double>
typedef ValueT viennashe::non_const_quantity< AssociatedT, ValueT >::value_type

Definition at line 91 of file simulator_quantity.hpp.

Constructor & Destructor Documentation

◆ non_const_quantity() [1/3]

template<typename AssociatedT , typename ValueT = double>
viennashe::non_const_quantity< AssociatedT, ValueT >::non_const_quantity ( std::string  quan_name,
std::size_t  num_values,
value_type  default_value = value_type() 
)
inline

Definition at line 94 of file simulator_quantity.hpp.

◆ non_const_quantity() [2/3]

template<typename AssociatedT , typename ValueT = double>
viennashe::non_const_quantity< AssociatedT, ValueT >::non_const_quantity ( std::string  quan_name,
std::vector< ValueT > const &  values_array 
)
inline

Definition at line 99 of file simulator_quantity.hpp.

◆ non_const_quantity() [3/3]

template<typename AssociatedT , typename ValueT = double>
viennashe::non_const_quantity< AssociatedT, ValueT >::non_const_quantity ( self_type const &  o)
inline

Definition at line 103 of file simulator_quantity.hpp.

Member Function Documentation

◆ at()

template<typename AssociatedT , typename ValueT = double>
ValueT viennashe::non_const_quantity< AssociatedT, ValueT >::at ( associated_type const &  elem) const
inline

Definition at line 108 of file simulator_quantity.hpp.

◆ get_value()

template<typename AssociatedT , typename ValueT = double>
ValueT viennashe::non_const_quantity< AssociatedT, ValueT >::get_value ( associated_type const &  elem) const
inline

Definition at line 107 of file simulator_quantity.hpp.

◆ name()

template<typename AssociatedT , typename ValueT = double>
std::string viennashe::non_const_quantity< AssociatedT, ValueT >::name ( ) const
inline

Definition at line 112 of file simulator_quantity.hpp.

◆ operator()()

template<typename AssociatedT , typename ValueT = double>
ValueT viennashe::non_const_quantity< AssociatedT, ValueT >::operator() ( associated_type const &  elem) const
inline

Definition at line 109 of file simulator_quantity.hpp.

◆ operator=()

template<typename AssociatedT , typename ValueT = double>
void viennashe::non_const_quantity< AssociatedT, ValueT >::operator= ( self_type const &  o)
inline

Definition at line 104 of file simulator_quantity.hpp.

◆ set_value()

template<typename AssociatedT , typename ValueT = double>
void viennashe::non_const_quantity< AssociatedT, ValueT >::set_value ( associated_type const &  elem,
ValueT  value 
)
inline

Definition at line 110 of file simulator_quantity.hpp.


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