SystemBathInteraction#

Quantarhei package (http://www.github.com/quantarhei)

systembathinteraction module

class quantarhei.qm.liouvillespace.systembathinteraction.SystemBathInteraction(sys_operators: Any = None, bath_correlation_matrix: Any = None, rates: Any = None, drates: Any = None, dtype: str = 'Lorentzian', osites: Any = None, orates: Any = None, system: Any = None)[source]#

Bases: Saveable

Describes interaction of an open quantum system with its environment

Stores the system–bath interaction operator in form of a set of operators on the Hilbert space of the system and correlation functions of the operator on the bath Hilbert space,

OR

It stores various relaxation and dephasing rates, to represent e.g. the Linblad form.

Parameters:

sys_operatorslist

List of the system part of the system-bath interaction Hamiltonian components

bath_correlation_matrix: CorrelationFunctionMatrix: Object of the CorrelationFunctionMatrix type holding all correlation functions needed for the description of system bath interaction
rateslist/tuple: List or tuple of rates. The total number of rates has to be the same as the number of operators in the sys_operator list
dratesarray: An array of dephasing rates. The dimension of the array must correspond to the dimension of the treated system.
dtypestr: Type of the dehasing defined in drates. The types are “Lorentzian” which is default, and correponds to a dephasing rate equation with the term -gamma

ho_{ab} on the right hand side. The dephasing

is exponential. The type “Gaussian” results in a Gaussian dephasing and corresponds to the term -gamma t

ho_{ab} on the right hand

side of the rate equation.

ositeslist, array: List or array of site indices on which the oscillators reside. The indices can repeat, indicating several modes on a single site.
oratesarray: Oscillator decay rates. This rates corresponds to the dephasing rate of the oscillations in a harmonic oscillator
system{Molecule, Aggregate}: Molecule or Aggregate object in which the system–bath interaction is specified

set_system(system: Any) → None[source]#: Sets the system attribute

get_time_axis() → Any[source]#: Returns the time axis of the storred correlation functions

get_correlation_function(where: Any) → Any[source]#: Returns the bath correlation function object defined by a pair of sites (tuple)

get_coft(n: int, m: int) → Any[source]#: Returns bath correlation function corresponding to sites n and m

get_coft_elsig(n_sig: Any, m_sig: Any) → Any[source]#: Returns bath correlation based on electronic signatures

get_goft_storage(config: dict | int | None = None, timeaxis: Any = None) → Any[source]#

Returns a lineshape function storage based on correlation functions

The function calculates g(t) fuctions based on the correlation functions specified in this object. This call fails if correlation functions are not specified.

Parameters:: config (dict) – Dictionary of the FunctionStorage configuration. If None submitted it wil produced g(t) for a standard 3rd order response calculation.

has_temperature() → bool[source]#: Checkst if the Aggregate has a defined temperature

get_temperature() → float[source]#: Returns temperature associated with the bath

get_reorganization_energy(i: int, j: int | None = None) → Any[source]#

Returns reorganization energy associated with a given site

If one index i is specified, the function returns reorganization energy associated with i-th site. If two indices are specified, the function returns crosscorrelation function (when i not equal j) or a correlation function of the site (when i = j)

get_correlation_time(i: int, j: int | None = None) → Any[source]#

get_sbitype() → str[source]#

Returns the type of SystemBathInteraction

Options are Lindblad_Form, Vibrational_Lindblad_Form and Linear_Coupling