votca 2026-dev
Loading...
Searching...
No Matches
votca::xtp::IPodCoupling Class Referencefinal

H-saturated, DFT + POD2-based electronic coupling calculator. More...

#include <ipodcoupling.h>

Inheritance diagram for votca::xtp::IPodCoupling:
Collaboration diagram for votca::xtp::IPodCoupling:

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
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 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.
void setOpenMPThreads (Index ompthreads)
void setProgObserver (ProgObserver< std::vector< Job > > *obs)
Public Member Functions inherited from votca::tools::Calculator
 Calculator ()=default
virtual ~Calculator ()=default
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 > >
tools::Property UpdateDFTOptions (const tools::Property &options)
tools::Property UpdateGWBSEOptions (const tools::Property &options)

Private Member Functions

void SetJobToFailed (Job::JobResult &jres, Logger &pLog, const std::string &errormessage)
void WriteLoggerToFile (const std::string &logfile, Logger &logger)
double GetPODCouplingFromProp (const tools::Property &podprop, Index levelA, Index levelB) const
const Atom & FindBoundaryAtomTowardSegment (const Segment &seg, Index target_segment_id) const
std::vector< Segment > PositionLinkersAlongChain (const Topology &top, const Segment &seg1_positioned, const std::vector< const Segment * > &linkers, const Segment &seg2_positioned) const

Private Attributes

tools::Property dftpackage_options_
tools::Property podcoupling_options_
Index numberofstatesA_ = 1
Index numberofstatesB_ = 1
bool include_linkers_ = false
bool do_dft_input_ = false
bool do_dft_run_ = false
bool do_dft_parse_ = false
bool do_podcoupling_ = false
bool store_dft_ = false

Additional Inherited Members

Public Types inherited from votca::xtp::ParallelXJobCalc< std::vector< Job > >
using Job
using Result
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

H-saturated, DFT + POD2-based electronic coupling calculator.

Kept separate from IQM so that IQM's existing behavior is unchanged.

For each neighbor-list pair: maps both segments (and, optionally, the linking segments between them) into one supermolecule, saturates the remaining covalently cut boundaries with H atoms (FragmentSaturator::SaturateExternalBonds, then RelaxNewAtoms, a constrained OpenBabel MMFF94/UFF relaxation), runs DFT on the saturated geometry and evaluates PODCoupling on the resulting orbitals.

Callname: ipodcoupling

Definition at line 49 of file ipodcoupling.h.

Member Function Documentation

◆ EvalJob()

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

Definition at line 204 of file ipodcoupling.cc.

◆ FindBoundaryAtomTowardSegment()

const Atom & votca::xtp::IPodCoupling::FindBoundaryAtomTowardSegment ( const Segment & seg,
Index target_segment_id ) const
private

Definition at line 133 of file ipodcoupling.cc.

◆ GetPODCouplingFromProp()

double votca::xtp::IPodCoupling::GetPODCouplingFromProp ( const tools::Property & podprop,
Index levelA,
Index levelB ) const
private

Definition at line 538 of file ipodcoupling.cc.

◆ Identify()

std::string votca::xtp::IPodCoupling::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 51 of file ipodcoupling.h.

◆ ParseSpecificOptions()

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

◆ PositionLinkersAlongChain()

std::vector< Segment > votca::xtp::IPodCoupling::PositionLinkersAlongChain ( const Topology & top,
const Segment & seg1_positioned,
const std::vector< const Segment * > & linkers,
const Segment & seg2_positioned ) const
private

Definition at line 150 of file ipodcoupling.cc.

◆ ReadJobFile()

void votca::xtp::IPodCoupling::ReadJobFile ( Topology & top)
virtual

Implements votca::xtp::JobCalculator.

Definition at line 550 of file ipodcoupling.cc.

◆ SetJobToFailed()

void votca::xtp::IPodCoupling::SetJobToFailed ( Job::JobResult & jres,
Logger & pLog,
const std::string & errormessage )
private

Definition at line 636 of file ipodcoupling.cc.

◆ WriteJobFile()

void votca::xtp::IPodCoupling::WriteJobFile ( const Topology & top)
virtual

Implements votca::xtp::JobCalculator.

Definition at line 81 of file ipodcoupling.cc.

◆ WriteLoggerToFile()

void votca::xtp::IPodCoupling::WriteLoggerToFile ( const std::string & logfile,
Logger & logger )
private

Definition at line 644 of file ipodcoupling.cc.

Member Data Documentation

◆ dftpackage_options_

tools::Property votca::xtp::IPodCoupling::dftpackage_options_
private

Definition at line 94 of file ipodcoupling.h.

◆ do_dft_input_

bool votca::xtp::IPodCoupling::do_dft_input_ = false
private

Definition at line 110 of file ipodcoupling.h.

◆ do_dft_parse_

bool votca::xtp::IPodCoupling::do_dft_parse_ = false
private

Definition at line 112 of file ipodcoupling.h.

◆ do_dft_run_

bool votca::xtp::IPodCoupling::do_dft_run_ = false
private

Definition at line 111 of file ipodcoupling.h.

◆ do_podcoupling_

bool votca::xtp::IPodCoupling::do_podcoupling_ = false
private

Definition at line 113 of file ipodcoupling.h.

◆ include_linkers_

bool votca::xtp::IPodCoupling::include_linkers_ = false
private

Definition at line 107 of file ipodcoupling.h.

◆ numberofstatesA_

Index votca::xtp::IPodCoupling::numberofstatesA_ = 1
private

Definition at line 100 of file ipodcoupling.h.

◆ numberofstatesB_

Index votca::xtp::IPodCoupling::numberofstatesB_ = 1
private

Definition at line 101 of file ipodcoupling.h.

◆ podcoupling_options_

tools::Property votca::xtp::IPodCoupling::podcoupling_options_
private

Definition at line 95 of file ipodcoupling.h.

◆ store_dft_

bool votca::xtp::IPodCoupling::store_dft_ = false
private

Definition at line 115 of file ipodcoupling.h.


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