votca 2024.2-dev
Loading...
Searching...
No Matches
votca::xtp::Chargecarrier Class Reference

#include <chargecarrier.h>

Collaboration diagram for votca::xtp::Chargecarrier:

Public Member Functions

 Chargecarrier (Index id)
 
bool hasNode ()
 
void updateLifetime (double dt)
 
void updateOccupationtime (double dt)
 
void updateSteps (Index t)
 
void resetCarrier ()
 
double getLifetime () const
 
Index getSteps () const
 
Index getCurrentNodeId () const
 
double getCurrentEnergy () const
 
const Eigen::Vector3d & getCurrentPosition () const
 
double getCurrentEscapeRate () const
 
GNodegetCurrentNode () const
 
void ReleaseNode ()
 
void settoNote (GNode *newnode)
 
void jumpAccordingEvent (const GLink &event)
 
const Eigen::Vector3d & get_dRtravelled () const
 
Index getId () const
 
void setId (Index id)
 

Private Attributes

Index id_
 
double lifetime
 
Index steps
 
Eigen::Vector3d dr_travelled_
 
GNodenode
 

Detailed Description

Definition at line 30 of file chargecarrier.h.

Constructor & Destructor Documentation

◆ Chargecarrier()

votca::xtp::Chargecarrier::Chargecarrier ( Index id)
inline

Definition at line 32 of file chargecarrier.h.

Member Function Documentation

◆ get_dRtravelled()

const Eigen::Vector3d & votca::xtp::Chargecarrier::get_dRtravelled ( ) const
inline

Definition at line 68 of file chargecarrier.h.

◆ getCurrentEnergy()

double votca::xtp::Chargecarrier::getCurrentEnergy ( ) const
inline

Definition at line 50 of file chargecarrier.h.

◆ getCurrentEscapeRate()

double votca::xtp::Chargecarrier::getCurrentEscapeRate ( ) const
inline

Definition at line 52 of file chargecarrier.h.

◆ getCurrentNode()

GNode & votca::xtp::Chargecarrier::getCurrentNode ( ) const
inline

Definition at line 53 of file chargecarrier.h.

◆ getCurrentNodeId()

Index votca::xtp::Chargecarrier::getCurrentNodeId ( ) const
inline

Definition at line 49 of file chargecarrier.h.

◆ getCurrentPosition()

const Eigen::Vector3d & votca::xtp::Chargecarrier::getCurrentPosition ( ) const
inline

Definition at line 51 of file chargecarrier.h.

◆ getId()

Index votca::xtp::Chargecarrier::getId ( ) const
inline

Definition at line 70 of file chargecarrier.h.

◆ getLifetime()

double votca::xtp::Chargecarrier::getLifetime ( ) const
inline

Definition at line 47 of file chargecarrier.h.

◆ getSteps()

Index votca::xtp::Chargecarrier::getSteps ( ) const
inline

Definition at line 48 of file chargecarrier.h.

◆ hasNode()

bool votca::xtp::Chargecarrier::hasNode ( )
inline

Definition at line 38 of file chargecarrier.h.

◆ jumpAccordingEvent()

void votca::xtp::Chargecarrier::jumpAccordingEvent ( const GLink & event)
inline

Definition at line 62 of file chargecarrier.h.

◆ ReleaseNode()

void votca::xtp::Chargecarrier::ReleaseNode ( )
inline

Definition at line 55 of file chargecarrier.h.

◆ resetCarrier()

void votca::xtp::Chargecarrier::resetCarrier ( )
inline

Definition at line 42 of file chargecarrier.h.

◆ setId()

void votca::xtp::Chargecarrier::setId ( Index id)
inline

Definition at line 71 of file chargecarrier.h.

◆ settoNote()

void votca::xtp::Chargecarrier::settoNote ( GNode * newnode)
inline

Definition at line 57 of file chargecarrier.h.

◆ updateLifetime()

void votca::xtp::Chargecarrier::updateLifetime ( double dt)
inline

Definition at line 39 of file chargecarrier.h.

◆ updateOccupationtime()

void votca::xtp::Chargecarrier::updateOccupationtime ( double dt)
inline

Definition at line 40 of file chargecarrier.h.

◆ updateSteps()

void votca::xtp::Chargecarrier::updateSteps ( Index t)
inline

Definition at line 41 of file chargecarrier.h.

Member Data Documentation

◆ dr_travelled_

Eigen::Vector3d votca::xtp::Chargecarrier::dr_travelled_
private

Definition at line 77 of file chargecarrier.h.

◆ id_

Index votca::xtp::Chargecarrier::id_
private

Definition at line 74 of file chargecarrier.h.

◆ lifetime

double votca::xtp::Chargecarrier::lifetime
private

Definition at line 75 of file chargecarrier.h.

◆ node

GNode* votca::xtp::Chargecarrier::node
private

Definition at line 78 of file chargecarrier.h.

◆ steps

Index votca::xtp::Chargecarrier::steps
private

Definition at line 76 of file chargecarrier.h.


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