A class that organizes output. More...

#include <writer.h>

Public Member Functions
	Logger (World &world, QObject *parent=0)
	create Logger More...

virtual void	saveTrapImage (const QString &name="%stub-traps.png")
	save an image of trap sites as png More...

virtual void	saveHoleImage (const QString &name="%stub-%step-holes.png")
	save an image of holes (at the current step) as png More...

virtual void	saveElectronImage (const QString &name="%stub-%step-electrons.png")
	save an image of electrons (at the current step) as png More...

virtual void	saveCarriersImage (const QString &name="%stub-%step-carriers.png")
	save an image of holes and electrons (at the current step) as png More...

virtual void	saveDefectImage (const QString &name="%stub-defects.png")
	save an image of defects as png More...

virtual void	saveImage (const QString &name="%stub-%step-all.png")
	save an image of electrons, holes, defects, and traps (at current step) as png More...

virtual void	saveGridPotential (const QString &name="%stub.grid")
	output the grid potential as (x, y, z, v) to a file More...

virtual void	saveCoulombEnergy (const QString &name="%stub-%step.coulomb")
	output the Coulomb potential as (x, y, z, v) to a file; requires the use of the GPU More...

virtual void	reportFluxStream ()
	output information about Sources and Drains (at the current step) to the main output file More...

virtual void	reportXYZStream ()
	output xyz information (at the current step) to the xyz file More...

virtual void	reportCarrier (ChargeAgent &charge)
	output carrier information (for example pathlength) to the carrier file More...

virtual void	reportExciton (ChargeAgent &charge1, ChargeAgent &charge2, bool recombined=false)
	output carrier information (for example pathlength) on two carriers at once to the exciton file More...

virtual void	initialize ()
	open the various output streams if they are turned on More...

Protected Attributes
World &	m_world
	reference to world More...

XYZWriter *	m_xyzWriter
	writer in charge of writing xyz files More...

FluxWriter *	m_fluxWriter
	writer in charge of writing source & drain information More...

CarrierWriter *	m_carrierWriter
	writer in charge of writing carrier information More...

ExcitonWriter *	m_excitonWriter
	writer in charge of writing multiple carrier's information (excitons) More...

Detailed Description

A class that organizes output.

Warning: You must manually call initialize() to open output streams

Constructor & Destructor Documentation

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

create Logger

Member Function Documentation

virtual void LangmuirCore::Logger::initialize ( )

virtual

open the various output streams if they are turned on

virtual void LangmuirCore::Logger::reportCarrier ( ChargeAgent & charge )

virtual

output carrier information (for example pathlength) to the carrier file

virtual void LangmuirCore::Logger::reportExciton	(	ChargeAgent &	charge1,
		ChargeAgent &	charge2,
		bool	recombined = `false`
	)

virtual

output carrier information (for example pathlength) on two carriers at once to the exciton file

virtual void LangmuirCore::Logger::reportFluxStream ( )

virtual

output information about Sources and Drains (at the current step) to the main output file

virtual void LangmuirCore::Logger::reportXYZStream ( )

virtual

output xyz information (at the current step) to the xyz file

virtual void LangmuirCore::Logger::saveCarriersImage ( const QString & name = "%stub-%step-carriers.png" )

virtual

save an image of holes and electrons (at the current step) as png

virtual void LangmuirCore::Logger::saveCoulombEnergy ( const QString & name = "%stub-%step.coulomb" )

virtual

output the Coulomb potential as (x, y, z, v) to a file; requires the use of the GPU

virtual void LangmuirCore::Logger::saveDefectImage ( const QString & name = "%stub-defects.png" )

virtual

save an image of defects as png

virtual void LangmuirCore::Logger::saveElectronImage ( const QString & name = "%stub-%step-electrons.png" )

virtual

save an image of electrons (at the current step) as png

virtual void LangmuirCore::Logger::saveGridPotential ( const QString & name = "%stub.grid" )

virtual

output the grid potential as (x, y, z, v) to a file

virtual void LangmuirCore::Logger::saveHoleImage ( const QString & name = "%stub-%step-holes.png" )

virtual

save an image of holes (at the current step) as png

virtual void LangmuirCore::Logger::saveImage ( const QString & name = "%stub-%step-all.png" )

virtual

save an image of electrons, holes, defects, and traps (at current step) as png

virtual void LangmuirCore::Logger::saveTrapImage ( const QString & name = "%stub-traps.png" )

virtual

save an image of trap sites as png

Member Data Documentation

CarrierWriter* LangmuirCore::Logger::m_carrierWriter

protected

writer in charge of writing carrier information

ExcitonWriter* LangmuirCore::Logger::m_excitonWriter

protected

writer in charge of writing multiple carrier's information (excitons)

FluxWriter* LangmuirCore::Logger::m_fluxWriter

protected

writer in charge of writing source & drain information

World& LangmuirCore::Logger::m_world

protected

reference to world

XYZWriter* LangmuirCore::Logger::m_xyzWriter

protected

writer in charge of writing xyz files

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

/home/adam/opt/langmuir/src/langmuirCore/include/writer.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation