Classes
class	Agent
	A class that abstractly represents an object that can occupy grid sites. More...

class	CarrierWriter
	A class to output carrier stats (lifetime and pathlength) More...

class	ChargeAgent
	A class to represent moving charged particles. More...

class	CheckPointer
	A class to read and write checkpoint files. More...

class	CommandLineParser
	A class to parse command line arguments. More...

struct	ConfigurationInfo
	A struct to temporarily store site IDs. More...

class	DrainAgent
	A class to remove charges. More...

class	ElectronAgent
	A class to represent moving negative charges. More...

class	ElectronDrainAgent
	A class to remove ElectronAgents. More...

class	ElectronSourceAgent
	A class to inject ElectronAgents. More...

class	ExcitonSourceAgent
	A class to inject Excitons. More...

class	ExcitonWriter
	A class to output exciton stats (lifetime and pathlength) More...

class	FluxAgent
	A class to change the number of carriers in the system. More...

class	FluxWriter
	A class to output source and drain info. More...

class	Grid
	A class to hold Agents, calculate their positions, and store the background potential. More...

class	GridImage
	A class to draw images of the grid. More...

class	HoleAgent
	A class to represent moving positive charges. More...

class	HoleDrainAgent
	A class to remove HoleAgents. More...

class	HoleSourceAgent
	A class to inject HoleAgents. More...

class	KeyValueParser
	A class to read the parameters and store them in the correct place. More...

class	Logger
	A class that organizes output. More...

class	NodeFileParser
	A class to parse the PBS_NODEFILE and PBS_GPUFILE. More...

class	OpenClHelper
	A class to run OpenCL calculations. More...

class	OutputInfo
	brief A class to generate file names using the SimulationParameters More...

class	OutputStream
	A class to combine QFile, QTextStream and OutputInfo (QFileInfo). More...

class	Potential
	A class to calculate the potential. More...

class	Random
	A class to generate random numbers. More...

class	RecombinationAgent
	A class to remove Excitons. More...

class	Simulation
	A class to orchestrate the calculation. More...

struct	SimulationParameters
	A struct to store all simulation options. More...

class	SourceAgent
	A class to inject charges. More...

class	TypedVariable
	A template class to map between variable names (keys) and locations (references) More...

class	Variable
	A class to map between variable names (keys) and locations (references) More...

class	World
	A class to hold all objects in a simulation. More...

class	XYZWriter
	A class to output xyz files. More...

Functions
QTextStream &	operator<< (QTextStream &stream, const Agent::Type e)
	Output Agent type enum to stream. More...

QDebug	operator<< (QDebug dbg, const Agent::Type e)
	Output Agent type enum to debug information. More...

static std::ostream &	operator<< (std::ostream &stream, QString &string)

static std::istream &	operator>> (std::istream &stream, QString &string)

QTextStream &	operator<< (QTextStream &stream, const Grid::CubeFace e)
	Overload QTextStream for the Grid::CubeFace Enum. More...

QDebug	operator<< (QDebug dbg, const Grid::CubeFace e)
	Overload QDebug for the Grid::CubeFace Enum. More...

void	backupFile (const QString &name)
	Back up a file. More...

void	setCalculatedValues (SimulationParameters &par)
	sets parameters that depend upon other parameters More...

void	checkSimulationParameters (SimulationParameters &par)
	check the parameters, making sure they are valid More...

QTextStream &	operator<< (QTextStream &stream, const QDateTime &datetime)
	output QDateTime as qint64 mSecsSinceEpoch More...

QTextStream &	operator<< (QTextStream &stream, const Variable &variable)
	overload operator to write keyValue() to a stream More...

QDebug	operator<< (QDebug dbg, const Variable &variable)
	overload operator to write keyValue() to a QDebug More...

std::ostream &	operator<< (std::ostream &stream, Variable &variable)
	Operator overload to output to output 'key = value' to std::ostream. More...

Function Documentation

void LangmuirCore::backupFile ( const QString & name )

Back up a file.

Parameters

name	a relative or absolute file name path

Back up the file using the current time and a revision number. The file is backed up as path/file.date.num, where num is determined by examing existing files in path with a similiar form (path/file.current_date.a_number). The file is renamed, not copied.

Warning: gives an error if a directory is passed instead of a file; gives an error if the file can not be renamed

void LangmuirCore::checkSimulationParameters ( SimulationParameters & par )

inline

check the parameters, making sure they are valid

QTextStream & LangmuirCore::operator<<	(	QTextStream &	stream,
		const QDateTime &	datetime
	)

inline

output QDateTime as qint64 mSecsSinceEpoch

QTextStream& LangmuirCore::operator<<	(	QTextStream &	stream,
		const Agent::Type	e
	)

inline

Output Agent type enum to stream.

QDebug LangmuirCore::operator<<	(	QDebug	dbg,
		const Agent::Type	e
	)

inline

Output Agent type enum to debug information.

static std::ostream& LangmuirCore::operator<<	(	std::ostream &	stream,
		QString &	string
	)

inlinestatic

QTextStream& LangmuirCore::operator<<	(	QTextStream &	stream,
		const Variable &	variable
	)

inline

overload operator to write keyValue() to a stream

Operator overload to output 'key = value' to QTextStream.

QDebug LangmuirCore::operator<<	(	QDebug	dbg,
		const Variable &	variable
	)

inline

overload operator to write keyValue() to a QDebug

Operator overload to output 'key = value' to QDebug.

std::ostream& LangmuirCore::operator<<	(	std::ostream &	stream,
		Variable &	variable
	)

inline

Operator overload to output to output 'key = value' to std::ostream.

Operator overload to output to output 'key = value' to std::ofstream.

QTextStream& LangmuirCore::operator<<	(	QTextStream &	stream,
		const Grid::CubeFace	e
	)

Overload QTextStream for the Grid::CubeFace Enum.

QDebug LangmuirCore::operator<<	(	QDebug	dbg,
		const Grid::CubeFace	e
	)

Overload QDebug for the Grid::CubeFace Enum.

static std::istream& LangmuirCore::operator>>	(	std::istream &	stream,
		QString &	string
	)

inlinestatic

void LangmuirCore::setCalculatedValues ( SimulationParameters & par )

inline

sets parameters that depend upon other parameters

Classes

Functions

Function Documentation