votca::xtp::StaticRates Class Reference

the rates stored in the ToFGraph, constant in time More...

#include <kmcrates.h>

Inheritance diagram for votca::xtp::StaticRates:

Collaboration diagram for votca::xtp::StaticRates:

Public Member Functions
	StaticRates (const ToFGraph &graph)
double	Rate (Index edge, double) const override
	rate of edge e at time t
double	EscapeRate (Index site, double) const override
double	UpperBound (Index edge) const override
	an upper bound of Rate(edge, t) for all t (needed by thinning)
bool	isStatic () const override
	true if no rate depends on time
Public Member Functions inherited from votca::xtp::TimeDependentRates
virtual	~TimeDependentRates ()=default
virtual double	Period () const
	common period T of all rates if they are periodic, 0 otherwise
const ToFGraph &	Graph () const

Additional Inherited Members
Protected Member Functions inherited from votca::xtp::TimeDependentRates
	TimeDependentRates (const ToFGraph &graph)
Protected Attributes inherited from votca::xtp::TimeDependentRates
const ToFGraph &	graph_

Detailed Description

the rates stored in the ToFGraph, constant in time

Definition at line 80 of file kmcrates.h.

Constructor & Destructor Documentation

StaticRates()

votca::xtp::StaticRates::StaticRates ( const ToFGraph & graph )

inlineexplicit

Definition at line 82 of file kmcrates.h.

Member Function Documentation

EscapeRate()

double votca::xtp::StaticRates::EscapeRate ( Index site, double t ) const

inlineoverridevirtual

sum of the rates of the out-edges of site i at time t; override if it can be computed faster than the sum over the edges

Reimplemented from votca::xtp::TimeDependentRates.

Definition at line 86 of file kmcrates.h.

isStatic()

bool votca::xtp::StaticRates::isStatic ( ) const

inlineoverridevirtual

true if no rate depends on time

Reimplemented from votca::xtp::TimeDependentRates.

Definition at line 92 of file kmcrates.h.

Rate()

double votca::xtp::StaticRates::Rate ( Index edge, double t ) const

inlineoverridevirtual

rate of edge e at time t

Implements votca::xtp::TimeDependentRates.

Definition at line 83 of file kmcrates.h.

UpperBound()

double votca::xtp::StaticRates::UpperBound ( Index edge ) const

inlineoverridevirtual

an upper bound of Rate(edge, t) for all t (needed by thinning)

Implements votca::xtp::TimeDependentRates.

Definition at line 89 of file kmcrates.h.

---

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

• xtp/include/votca/xtp/kmcrates.h