LangmuirCore::Potential Class Reference

A class to calculate the potential. More...

#include <potential.h>

Public Member Functions
	Potential (World &world, QObject *parent=0)
	Potential Create the potential. More...
void	setPotentialZero ()
	sets the value of the potential to zero at every grid site More...
void	setPotentialLinear ()
	Adds a linear potential calcualted from voltage.left and voltage.right along the x-direction. More...
void	setPotentialGate ()
	Adds a linear potential calculated from slope.z along the z-direction. More...
void	setPotentialTraps (const QList< int > &trapIDs=QList< int >(), const QList< double > &trapPotentials=QList< double >())
	Adds shifts to the potential at the various sites. More...
void	precalculateArrays ()
	pre-calculates r2, r, and 1/r More...
void	updateCouplingConstants ()
	pre-calculates coupling constants More...
double	coulombE (int site_i)
	calculates Coulomb potential from electrons at specific grid site More...
double	coulombImageE (int site_i)
	calculates Coulomb image-potential from electrons at specific grid site More...
double	gaussE (int site_i)
	calculates Coulomb potential from electrons at specific grid site, assuming gaussians More...
double	gaussImageE (int site_i)
	calculates Coulomb image-potential from electrons at specific grid site, assuming gaussians More...
double	coulombH (int site_i)
	calculates Coulomb potential from holes at specific grid site More...
double	coulombImageH (int site_i)
	calculates Coulomb image-potential from holes at specific grid site More...
double	gaussH (int site)
	calculates Coulomb potential from holes at specific grid site, assuming gaussians More...
double	gaussImageH (int site)
	calculates Coulomb image-potential from holes at specific grid site, assuming gaussians More...
double	coulombD (int site_i)
	calculates Coulomb potential from charged defects at specific grid site More...
double	coulombImageD (int site_i)
	calculates Coulomb image-potential from charged defects at specific grid site More...
double	gaussD (int site_i)
	calculates Coulomb potential from charged defects at specific grid site, assuming gaussians More...
double	gaussImageD (int site_i)
	calculates Coulomb image-potential from charged defects at specific grid site, assuming gaussians More...

Private Attributes
World &	m_world
	reference to the World More...

Detailed Description

A class to calculate the potential.

Constructor & Destructor Documentation

LangmuirCore::Potential::Potential	(	World &	world,
		QObject *	parent = 0
	)

Potential Create the potential.

Parameters

world	reference to the World
parent	QObject this belongs to

Member Function Documentation

double LangmuirCore::Potential::coulombD

(

int

site_i

)

calculates Coulomb potential from charged defects at specific grid site

Parameters

site_i

the site of interest

double LangmuirCore::Potential::coulombE

(

int

site_i

)

calculates Coulomb potential from electrons at specific grid site

Parameters

site_i

the site of interest

double LangmuirCore::Potential::coulombH

(

int

site_i

)

calculates Coulomb potential from holes at specific grid site

Parameters

site_i

the site of interest

double LangmuirCore::Potential::coulombImageD

(

int

site_i

)

calculates Coulomb image-potential from charged defects at specific grid site

Parameters

site_i

the site of interest

double LangmuirCore::Potential::coulombImageE

(

int

site_i

)

calculates Coulomb image-potential from electrons at specific grid site

Parameters

site_i

the site of interest

double LangmuirCore::Potential::coulombImageH

(

int

site_i

)

calculates Coulomb image-potential from holes at specific grid site

Parameters

site_i

the site of interest

double LangmuirCore::Potential::gaussD

(

int

site_i

)

calculates Coulomb potential from charged defects at specific grid site, assuming gaussians

Parameters

site_i

the site of interest

double LangmuirCore::Potential::gaussE

(

int

site_i

)

calculates Coulomb potential from electrons at specific grid site, assuming gaussians

Parameters

site_i

the site of interest

double LangmuirCore::Potential::gaussH

(

int

site

)

calculates Coulomb potential from holes at specific grid site, assuming gaussians

Parameters

site	the site of interest

double LangmuirCore::Potential::gaussImageD

(

int

site_i

)

calculates Coulomb image-potential from charged defects at specific grid site, assuming gaussians

Parameters

site_i

the site of interest

double LangmuirCore::Potential::gaussImageE

(

int

site_i

)

calculates Coulomb image-potential from electrons at specific grid site, assuming gaussians

Parameters

site_i

the site of interest

double LangmuirCore::Potential::gaussImageH

(

int

site

)

calculates Coulomb image-potential from holes at specific grid site, assuming gaussians

Parameters

site	the site of interest

void LangmuirCore::Potential::precalculateArrays

(

)

pre-calculates r2, r, and 1/r

void LangmuirCore::Potential::setPotentialGate

(

)

Adds a linear potential calculated from slope.z along the z-direction.

void LangmuirCore::Potential::setPotentialLinear

(

)

Adds a linear potential calcualted from voltage.left and voltage.right along the x-direction.

void LangmuirCore::Potential::setPotentialTraps	(	const QList< int > &	trapIDs = QList< int >(),
		const QList< double > &	trapPotentials = QList< double >()
	)

Adds shifts to the potential at the various sites.

Parameters

trapIDs	list of site ids
trapPotentials	list of shifts

void LangmuirCore::Potential::setPotentialZero

(

)

sets the value of the potential to zero at every grid site

void LangmuirCore::Potential::updateCouplingConstants

(

)

pre-calculates coupling constants

Member Data Documentation

World& LangmuirCore::Potential::m_world

private

reference to the World

---

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

• /home/adam/opt/langmuir/src/langmuirCore/include/potential.h