votca::xtp::IEXCITON Class Reference

Evaluates Transition Charge distributions classically. More...

#include <iexcitoncl.h>

Inheritance diagram for votca::xtp::IEXCITON:

Collaboration diagram for votca::xtp::IEXCITON:

Public Member Functions
std::string	Identify () const
	Calculator name.
Job::JobResult	EvalJob (const Topology &top, Job &job, QMThread &opThread)
void	WriteJobFile (const Topology &top)
void	ReadJobFile (Topology &top)
Public Member Functions inherited from votca::xtp::ParallelXJobCalc< std::vector< Job > >
	ParallelXJobCalc ()=default
	~ParallelXJobCalc () override=default
std::string	Identify () const override=0
	Calculator name.
void	ParseOptions (const tools::Property &opt) final
bool	Evaluate (const Topology &top) final
virtual void	CustomizeLogger (QMThread &thread)
virtual Result	EvalJob (const Topology &top, Job &job, QMThread &thread)=0
void	LockCout ()
void	UnlockCout ()
void	LockLog ()
void	UnlockLog ()
Public Member Functions inherited from votca::xtp::JobCalculator
	JobCalculator ()=default
	~JobCalculator () override=default
std::string	Identify () const override=0
	Calculator name.
std::string	Package () const final
	Package name.
bool	EvaluateFrame (const Topology &top)
void	Initialize (const tools::Property &opt) final
	Initializes a calculator from an XML file with options.
virtual void	WriteJobFile (const Topology &top)=0
virtual void	ReadJobFile (Topology &top)=0
void	setOpenMPThreads (Index ompthreads)
void	setProgObserver (ProgObserver< std::vector< Job > > *obs)
Public Member Functions inherited from votca::tools::Calculator
	Calculator ()=default
virtual	~Calculator ()=default
virtual std::string	Identify () const =0
	Calculator name.
virtual std::string	Package () const =0
	Package name.
virtual void	Initialize (const Property &user_options)=0
	Initializes a calculator from an XML file with options.
void	setnThreads (Index nThreads)
	Sets number of threads to use.

Protected Member Functions
void	ParseSpecificOptions (const tools::Property &user_options)
Protected Member Functions inherited from votca::xtp::ParallelXJobCalc< std::vector< Job > >
virtual void	ParseSpecificOptions (const tools::Property &options)=0
tools::Property	UpdateDFTOptions (const tools::Property &options)
tools::Property	UpdateGWBSEOptions (const tools::Property &options)
virtual void	ParseOptions (const tools::Property &opt)=0
virtual bool	Evaluate (const Topology &top)=0

Private Member Functions
QMState	GetElementFromMap (const std::string &elementname) const
std::map< std::string, QMState >	FillParseMaps (const std::string &Mapstring)

Private Attributes
double	cutoff_
std::map< std::string, QMState >	statemap_

Additional Inherited Members
Public Types inherited from votca::xtp::ParallelXJobCalc< std::vector< Job > >
using	Job = typename JobContainer::value_type
using	Result = typename Job::JobResult
Protected Attributes inherited from votca::xtp::ParallelXJobCalc< std::vector< Job > >
std::vector< Job >	XJobs_
tools::Mutex	coutMutex_
tools::Mutex	logMutex_
std::string	mapfile_
std::string	jobfile_
Protected Attributes inherited from votca::xtp::JobCalculator
Index	openmp_threads_
ProgObserver< std::vector< Job > > *	progObs_
Protected Attributes inherited from votca::tools::Calculator
Index	nThreads_
bool	maverick_

Detailed Description

Evaluates Transition Charge distributions classically.

Evaluates the electrostatic classical coupling between molecules in their excited states. Callname: iexcitoncl

Definition at line 45 of file iexcitoncl.h.

Member Function Documentation

EvalJob()

Job::JobResult votca::xtp::IEXCITON::EvalJob	(	const Topology &	top,
		Job &	job,
		QMThread &	opThread
	)

Definition at line 73 of file iexcitoncl.cc.

FillParseMaps()

std::map< std::string, QMState > votca::xtp::IEXCITON::FillParseMaps ( const std::string &  Mapstring )

private

Definition at line 52 of file iexcitoncl.cc.

GetElementFromMap()

QMState votca::xtp::IEXCITON::GetElementFromMap ( const std::string &  elementname ) const

private

Definition at line 143 of file iexcitoncl.cc.

Identify()

std::string votca::xtp::IEXCITON::Identify ( ) const

inlinevirtual

Calculator name.

This name is used to register a calculator in a Factory It the name of the XML file with the default calculator options stored in VOTCASHARE

Returns

calculator name

Implements votca::xtp::ParallelXJobCalc< std::vector< Job > >.

Definition at line 47 of file iexcitoncl.h.

ParseSpecificOptions()

void votca::xtp::IEXCITON::ParseSpecificOptions ( const tools::Property &  user_options )

protectedvirtual

Implements votca::xtp::ParallelXJobCalc< std::vector< Job > >.

Definition at line 44 of file iexcitoncl.cc.

ReadJobFile()

void votca::xtp::IEXCITON::ReadJobFile ( Topology &  top )

virtual

Implements votca::xtp::JobCalculator.

Definition at line 220 of file iexcitoncl.cc.

WriteJobFile()

void votca::xtp::IEXCITON::WriteJobFile ( const Topology &  top )

virtual

Implements votca::xtp::JobCalculator.

Definition at line 159 of file iexcitoncl.cc.

Member Data Documentation

cutoff_

double votca::xtp::IEXCITON::cutoff_

private

Definition at line 60 of file iexcitoncl.h.

statemap_

std::map<std::string, QMState> votca::xtp::IEXCITON::statemap_

private

Definition at line 61 of file iexcitoncl.h.

---

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

• xtp/src/libxtp/jobcalculators/iexcitoncl.h
• xtp/src/libxtp/jobcalculators/iexcitoncl.cc