Xyce  6.1
Xyce::Device::Specie Class Reference

#include <N_DEV_Specie.h>

Public Member Functions

 Specie (std::string name, double diff_prefac, double act_energy, int charge_state, int index)
 
const std::string & getName () const
 
void setName (std::string &name)
 
int getChargeState ()
 
void setChargeState (int chargestate)
 
double getDiffPrefactor ()
 
void setDiffPrefactor (double p)
 
double getActEnergy ()
 
void setActEnergy (double Energy)
 
bool getEnhancedDiffusion ()
 
void setBCEnhancedDiffusion (int cI, double sigma, int BCCC, double hopLength)
 
int getBCCarrierIndex ()
 
double getBCHopLength ()
 
double getBCSigma ()
 
int getMyIndex ()
 
int getBCCarrierCharge ()
 
void setBCThermalVelocity (double TV)
 
template<class ScalarT >
ScalarT getDiffusionCoefficient (ScalarT Temperature)
 
template<class ScalarT >
ScalarT getDiffusionCoefficient (ScalarT Temperature, std::vector< ScalarT > &concs, std::vector< ScalarT > &constant_vec)
 

Private Attributes

std::string Name
 
double DiffusionPrefactor
 
double ActivationEnergy
 
int ChargeState
 
int carrierIndex
 
double sigma
 
double hopLength
 
double thermalVelocity
 
bool enhancedDiffusion
 
int myIndex
 
int BCCarrierCharge
 

Detailed Description

Definition at line 60 of file N_DEV_Specie.h.

Constructor & Destructor Documentation

Xyce::Device::Specie::Specie ( std::string  name,
double  diff_prefac,
double  act_energy,
int  charge_state,
int  index 
)
inline

Definition at line 63 of file N_DEV_Specie.h.

Member Function Documentation

double Xyce::Device::Specie::getActEnergy ( )
inline

Definition at line 89 of file N_DEV_Specie.h.

int Xyce::Device::Specie::getBCCarrierCharge ( )
inline

Definition at line 97 of file N_DEV_Specie.h.

int Xyce::Device::Specie::getBCCarrierIndex ( )
inline

Definition at line 93 of file N_DEV_Specie.h.

double Xyce::Device::Specie::getBCHopLength ( )
inline

Definition at line 94 of file N_DEV_Specie.h.

double Xyce::Device::Specie::getBCSigma ( )
inline

Definition at line 95 of file N_DEV_Specie.h.

int Xyce::Device::Specie::getChargeState ( )
inline

Definition at line 85 of file N_DEV_Specie.h.

double Xyce::Device::Specie::getDiffPrefactor ( )
inline

Definition at line 87 of file N_DEV_Specie.h.

template<class ScalarT >
ScalarT Xyce::Device::Specie::getDiffusionCoefficient ( ScalarT  Temperature)
inline

Definition at line 129 of file N_DEV_Specie.h.

template<class ScalarT >
ScalarT Xyce::Device::Specie::getDiffusionCoefficient ( ScalarT  Temperature,
std::vector< ScalarT > &  concs,
std::vector< ScalarT > &  constant_vec 
)

Definition at line 145 of file N_DEV_Specie.h.

bool Xyce::Device::Specie::getEnhancedDiffusion ( )
inline

Definition at line 91 of file N_DEV_Specie.h.

int Xyce::Device::Specie::getMyIndex ( )
inline

Definition at line 96 of file N_DEV_Specie.h.

const std::string& Xyce::Device::Specie::getName ( ) const
inline

Definition at line 83 of file N_DEV_Specie.h.

void Xyce::Device::Specie::setActEnergy ( double  Energy)
inline

Definition at line 90 of file N_DEV_Specie.h.

void Xyce::Device::Specie::setBCEnhancedDiffusion ( int  cI,
double  sigma,
int  BCCC,
double  hopLength 
)

Definition at line 68 of file N_DEV_Specie.C.

void Xyce::Device::Specie::setBCThermalVelocity ( double  TV)
inline

Definition at line 98 of file N_DEV_Specie.h.

void Xyce::Device::Specie::setChargeState ( int  chargestate)
inline

Definition at line 86 of file N_DEV_Specie.h.

void Xyce::Device::Specie::setDiffPrefactor ( double  p)
inline

Definition at line 88 of file N_DEV_Specie.h.

void Xyce::Device::Specie::setName ( std::string &  name)
inline

Definition at line 84 of file N_DEV_Specie.h.

Member Data Documentation

double Xyce::Device::Specie::ActivationEnergy
private

Definition at line 107 of file N_DEV_Specie.h.

int Xyce::Device::Specie::BCCarrierCharge
private

Definition at line 116 of file N_DEV_Specie.h.

int Xyce::Device::Specie::carrierIndex
private

Definition at line 110 of file N_DEV_Specie.h.

int Xyce::Device::Specie::ChargeState
private

Definition at line 108 of file N_DEV_Specie.h.

double Xyce::Device::Specie::DiffusionPrefactor
private

Definition at line 106 of file N_DEV_Specie.h.

bool Xyce::Device::Specie::enhancedDiffusion
private

Definition at line 114 of file N_DEV_Specie.h.

double Xyce::Device::Specie::hopLength
private

Definition at line 112 of file N_DEV_Specie.h.

int Xyce::Device::Specie::myIndex
private

Definition at line 115 of file N_DEV_Specie.h.

std::string Xyce::Device::Specie::Name
private

Definition at line 105 of file N_DEV_Specie.h.

double Xyce::Device::Specie::sigma
private

Definition at line 111 of file N_DEV_Specie.h.

double Xyce::Device::Specie::thermalVelocity
private

Definition at line 113 of file N_DEV_Specie.h.


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