Calculators

Requiring full response

These calculators require the full response from a TDDFT calculation in the form of a BaseResponse object.

class rhodent.calculators.DensityCalculator(gpw_file, response, filter_occ=[], filter_unocc=[], *, times=None, pulses=None, frequencies=None, frequency_broadening=0)

Calculate densities in the time or frequency domain.

The induced density (i.e. the density minus the ground state density) is to first order given by

$$\delta n(\mathit{r})=-2\sum _{ia}^{\text{eh}}{n}_{ia}(\mathit{r})\mathrm{Re}\delta {\rho }_{ia}$$

plus PAW corrections, where $n_{ia}(\mathit{r})$ is the density of ground state Kohn-Sham pair $ia$

$$n_{ia}(\mathit{r})={\psi }_i^{(0)}(\mathit{r}){\psi }_a^{(0)}(\mathit{r}).$$

In the time domain, electrons and holes densities can be computed.

$$\begin{array}{r}\begin{array}{rl}{n}^{\text{holes}}(\mathit{r})& =\sum _{i{i}^{\prime }}{n}_{i{i}^{\prime }}(\mathit{r})\delta {\rho }_{i{i}^{\prime }}\\ n^{\text{electrons}}(\mathit{r})& =\sum _{a{a}^{\prime }}{n}_{a{a}^{\prime }}(\mathit{r})\delta {\rho }_{a{a}^{\prime }}.\end{array}\end{array}$$

Refer to the documentation of HotCarriersCalculator for definitions of $\delta {\rho }_{i{i}^{\prime }}$ and $\delta {\rho }_{a{a}^{\prime }}$.

Parameters:

• gpw_file (str) – Filename of GPAW ground state file.

• response (BaseResponse) – Response object.

• filter_occ (Sequence[tuple[float, float]]) – Filters for occupied states (holes). Provide a list of tuples (low, high) to compute the density of holes with energies within the interval low-high.

• filter_unocc (Sequence[tuple[float, float]]) – Filters for unoccupied states (electrons). Provide a list of tuples (low, high) to compute the density of excited electrons with energies within the interval low-high.

• times (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) –

  Compute densities in the time domain, for these times (or as close to them as possible). In units of as.

  May not be used together with frequencies or frequency_broadening.

• pulses (Optional[Collection[Union[Perturbation, Laser, dict, None]]]) –

  Compute densities in the time domain, in response to these pulses. If none, then no pulse convolution is performed.

  May not be used together with frequencies or frequency_broadening.

• frequencies (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) –

  Compute densities in the frequency domain, for these frequencies. In units of eV.

  May not be used together with times or pulses.

• frequency_broadening (float) –

  Compute densities in the frequency domain, with Gaussian broadening of this width. In units of eV.

  May not be used together with times or pulses.

property N_c: ndarray[tuple[int, ...], dtype[int64]]

Number of points in each Cartesian direction of the grid.

property calc: gpaw.GPAW

GPAW calculator instance.

calculate_and_write(out_fname, which='induced', write_extra={})

Calculate density contributions.

Densities are saved in a numpy archive, ULM file or cube file depending on whether the file extension is .npz, .ulm, or .cube.

If the file extension is .cube then out_fname is taken to be a format string that takes the following attributes.

Accepts variables

• {time} - Time in units of as (time domain only).

• {freq} - Frequency in units of eV (frequency domain only).

• {which} - The which argument.

• {pulsefreq} - Pulse frequency in units of eV (time domain only).

• {pulsefwhm} - Pulse FWHM in units of fs (time domain only).

Examples

• out_fname = {which}_density_t{time:09.1f}.cube.

• out_fname = {which}_density_w{freq:05.2f}.cube.

Parameters:

• out_fname (str) – File name of the resulting data file.

• which (str | list[str]) –

  String, or list of strings specifying the types of density to compute:

  • induced - Induced density.

  • holes - Holes density (only allowed in the time domain).

  • electrons - Electrons density (only allowed in the time domain).

• write_extra (dict[str, Any]) – Dictionary of extra key-value pairs to write to the data file.

property cell_cv: ndarray[tuple[int, ...], dtype[float64]]

Cell vectors.

property gd: GridDescriptor

Real space grid.

property gdshape: tuple[int, int, int]

Shape of the real space grid.

get_density(rho_nn, nn_indices, fltn1=slice(None, None, None), fltn2=slice(None, None, None), u=0)

Calculate a real space density from a density matrix in the Kohn-Sham basis.

Parameters:

• rho_nn (rhodent.typing.DistributedArray) – Density matrix $\delta {\rho }_{ia}$, $\delta {\rho }_{i{i}^{\prime }}$, or $\delta {\rho }_{a{a}^{\prime }}$.

• nn_indices (str) –

  Indices describing the density matrices rho_nn. One of

  • ia for induced density $\delta {\rho }_{i{a}^{\prime }}$.

  • ii for holes density $\delta {\rho }_{i{i}^{\prime }}$.

  • aa for electrons density $\delta {\rho }_{a{a}^{\prime }}$.

• flt_n1 – Filter selecting rows of the density matrix.

• flt_n2 – Filter selecting columns of the density matrix.

• u (int) – Kpoint index.

Return type:

Distributed array with the density in real space on the root rank.

get_result_keys(yield_total=True, yield_electrons=False, yield_holes=False)

Get the keys that each result will contain, and dimensions thereof.

Return type:

Object representing the data that will be present in the result objects.

icalculate(yield_total=True, yield_electrons=False, yield_holes=False)

Iteratively calculate results.

Parameters:

• yield_total (bool) – The results should include the total induced density.

• yield_holes (bool) – The results should include the holes densities, optionally decomposed by filter_occ.

• yield_electrons (bool) – The results should include the electrons densities, optionally decomposed by filter_unocc.

Yields:

Tuple (work, result) on the root rank of the calculation communicator. Does not yield on non-root ranks of the calculation communicator. –

work

An object representing the metadata (time, frequency or pulse) for the work done.

result

Object containg the calculation results for this time, frequency or pulse.

Return type:

Generator[tuple[WorkMetadata, Result], None, None]

property occ_filters: list[slice]

List of energy filters for occupied states.

property unocc_filters: list[slice]

List of energy filters for unoccupied states.

class rhodent.calculators.DipoleCalculator(response, voronoi=None, *, energies_occ=None, energies_unocc=None, sigma=None, times=None, pulses=None, frequencies=None, frequency_broadening=0)

Calculate the induced dipole moment in the time or frequency domain.

The induced dipole moment (i.e. the dipole moment minus the permanent component) is to first order given by

$$\delta \mathit{\mu }=-2\sum _{ia}^{\text{eh}}{\mathit{\mu }}_{ia}\mathrm{Re}\delta {\rho }_{ia},$$

where ${\mathit{\mu }}_{ia}$ is the dipole matrix element of ground state Kohn-Sham pair $ia$

$${\mathit{\mu }}_{ia}=\int {\psi }_i^{(0)}(\mathit{r})\mathit{r}{\psi }_a^{(0)}(\mathit{r})\mathrm{d}\mathit{r},$$

and $\delta {\rho }_{ia}$ the induced Kohn-Sham density matrix.

In the frequency domain, this calculator calculates the polarizability, i.e. the Fourier transform of the dipole moment divided by the perturbation.

$$\mathit{\alpha }(\omega )=-2\sum _{ia}^{\text{eh}}{\mathit{\mu }}_{ia}\frac{\mathcal{F}\left[\mathrm{Re}\delta {\rho }_{ia}\right](\omega )}{v(\omega )}.$$

The absorption spectrum in units of dipole strength function is the imaginary part of the polarizability times a prefactor

$$\mathit{S}(\omega )=\frac{2\omega }{\pi }\mathrm{Im}\mathit{\alpha }(\omega ).$$

This class can also compute projections of the above on Voronoi weights $w_{ia}$.

Parameters:

• response (BaseResponse) – Response object.

• voronoi (Optional[VoronoiWeights]) – Voronoi weights object.

• energies_occ (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Energy grid in units of eV for occupied levels (holes).

• energies_unocc (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Energy grid in units of eV for unoccupied levels (electrons)

• sigma (Optional[float]) – Gaussian broadening width for energy grid in units of eV.

• times (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) –

  Compute induced dipole in the time domain, for these times (or as close to them as possible). In units of as.

  May not be used together with frequencies or frequency_broadening.

• pulses (Optional[Collection[Union[Perturbation, Laser, dict, None]]]) –

  Compute induced dipole in the time domain, in response to these pulses. If none, then no pulse convolution is performed.

  May not be used together with frequencies or frequency_broadening.

• frequencies (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) –

  Compute polarizability in the frequency domain, for these frequencies. In units of eV.

  May not be used together with times or pulses.

• frequency_broadening (float) –

  Compute polarizability in the frequency domain, with Gaussian broadening of this width. In units of eV.

  May not be used together with times or pulses.

calculate_and_write(out_fname, write_extra={}, save_matrix=False, only_one_pulse=True)

Calculate induced dipole moments and transition contribution maps.

Dipole moments and contributions are saved in a numpy archive if the file extension is .npz or in an ULM file if the file extension is .ulm.

Parameters:

• out_fname (str) – File name of the resulting data file.

• write_extra (dict[str, Any]) – Dictionary of extra key-value pairs to write to the data file.

• save_matrix (bool) – Whether the transition energy distributions should be computed and saved.

• only_one_pulse (bool) – If False, group arrays by pulse. Only valid in time domain.

get_result_keys(yield_total_ia=False, yield_proj_ia=False, yield_total_ou=False, yield_proj_ou=False, decompose_v=True, v=None)

Get the keys that each result will contain, and dimensions thereof.

Parameters:

• yield_total_ia (bool) – The results should include the total dipole contributions in the electron-hole basis $-2{\mathit{\mu }}_{ia}\mathrm{Re}\delta {\rho }_{ia}$.

• yield_proj_ia (bool) – The results should include projections of the dipole contributions in the electron-hole basis $-2{\mathit{\mu }}_{ia}\mathrm{Re}\delta {\rho }_{ia}{w}_{ia}$.

• yield_total_ou (bool) – The results should include the total dipole contributions on the energy grid.

• yield_proj_ou (bool) – The results should include projections of the dipole contributions on the energy grid.

• decompose_v (bool) – The results should include the dipole moment and/or its contributions decomposed by Cartesian direction.

• v (Optional[int]) – If not None, then the results should include the v:th Cartesian component of the dipole moment and its contributions.

Return type:

ResultKeys

icalculate(yield_total_ia=False, yield_proj_ia=False, yield_total_ou=False, yield_proj_ou=False, decompose_v=True, v=None)

Iteratively calculate dipole contributions.

Parameters:

• yield_total_ia (bool) – The results should include the total dipole contributions in the electron-hole basis $-2{\mathit{\mu }}_{ia}\mathrm{Re}\delta {\rho }_{ia}$.

• yield_proj_ia (bool) – The results should include projections of the dipole contributions in the electron-hole basis $-2{\mathit{\mu }}_{ia}\mathrm{Re}\delta {\rho }_{ia}{w}_{ia}$.

• yield_total_ou (bool) – The results should include the total dipole contributions on the energy grid.

• yield_proj_ou (bool) – The results should include projections of the dipole contributions on the energy grid.

• decompose_v (bool) – The results should include the dipole moment and/or its contributions decomposed by Cartesian direction.

• v (Optional[int]) – If not None, then the results should include the v:th Cartesian component of the dipole moment and its contributions.

Yields:

Tuple (work, result) on the root rank of the calculation communicator. Does not yield on non-root ranks of the calculation communicator. –

work

An object representing the metadata (time, frequency or pulse) for the work done.

result

Object containg the calculation results for this time, frequency or pulse.

Return type:

Generator[tuple[WorkMetadata, Result], None, None]

property oscillator_strength_prefactor: ndarray[tuple[int, ...], dtype[float64]]

Conversion factor from polarizability to dipole strength function.

class rhodent.calculators.EnergyCalculator(response, voronoi=None, *, energies_occ=None, energies_unocc=None, sigma=None, times=None, pulses=None, frequencies=None, frequency_broadening=0)

Calculate energy contributions in the time domain.

The total energy can be written

$$E_{\text{tot}}(t)=E_{\text{tot}}^{(0)}+\sum _{ia}^{\text{eh}}{E}_{ia}(t)+E_{\text{pulse}}(t).$$

The contributions to the total energy are

$$E_{ia}=\frac{1}{2}[p_{ia}{\dot{q}}_{ia}-q_{ia}{\dot{p}}_{ia}-v_{ia}{q}_{ia}],$$

the contributions to the Hartree energy are

$$E_{ia}^{\text{c}}=-\frac{1}{2}[{\omega }_{ia}{q}_{ia}^2-q_{ia}{\dot{p}}_{ia}-v_{ia}{q}_{ia}],$$

and the rate of energy change is

$${\dot{E}}_{ia}=\frac{1}{2}[p_{ia}{\ddot{q}}_{ia}-q_{ia}{\ddot{p}}_{ia}-v_{ia}{\dot{q}}_{ia}-{\dot{v}}_{ia}{q}_{ia}].$$

The matrix element $v_{ia}$ can be computed from the dipole matrix element

$${\mathit{\mu }}_{ia}=\int {\psi }_i^{(0)}(\mathit{r})\mathit{r}{\psi }_a^{(0)}(\mathit{r})\mathrm{d}\mathit{r}$$

projected on the direction of the perturbation $\hat{\mathit{e}}$, the occupation number difference $f_{ia}$ and the pulse amplitude $v_{\text{pulse}}(t)$

$$v_{ia}=\sqrt{2f_{ia}}{\mathit{\mu }}_{ia}\cdot \hat{\mathit{e}}{v}_{\text{pulse}}.$$

Parameters:

• response (BaseResponse) – Response object.

• voronoi (Optional[VoronoiWeights]) – Voronoi weights object.

• energies_occ (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Energy grid in units of eV for occupied levels (holes).

• energies_unocc (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Energy grid in units of eV for unoccupied levels (electrons).

• sigma (Optional[float]) – Gaussian broadening width for energy grid in units of eV.

• times (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Compute energies in the time domain, for these times (or as close to them as possible). In units of as.

• pulses (Optional[Collection[Union[Perturbation, Laser, dict, None]]]) – Compute energies in the time domain, in response to these pulses. If none, then no pulse convolution is performed.

calculate_and_write(out_fname, write_extra={}, save_matrix=False, save_dist=False, only_one_pulse=True)

Calculate energy contributions.

Energies are saved in a numpy archive if the file extension is .npz or in an ULM file if the file extension is .ulm.

Parameters:

• out_fname (str) – File name of the resulting data file.

• write_extra (dict[str, Any]) – Dictionary of extra key-value pairs to write to the data file.

• save_matrix (bool) – Whether the electron-hole map matrix should be computed and saved.

• save_dist (bool) – Whether the transition energy distributions should be computed and saved.

• only_one_pulse (bool) – If False, group arrays by pulse.

get_result_keys(yield_total_E_ia=False, yield_proj_E_ia=False, yield_total_E_ou=False, yield_total_dists=False, direction=2)

Get the keys that each result will contain, and dimensions thereof.

Parameters:

• yield_total_E_ia (bool) – The results should include the contributions in the electron-hole basis to the total energy $E_{ia}$ and Coulomb energy $E_{ia}^{\text{c}}$

• yield_proj_E_ia (bool) – The results should include the contributions in the electron-hole basis to the total energy projected on the occupied and unoccupied Voronoi weights $E_{ia}{w}_i$ and $E_{ia}{w}_a$.

• yield_total_E_ou (bool) – The results should include the contributions the total energy broadened on the occupied and unoccupied energy grids $\sum _{ia}{E}_{ia}\delta ({\epsilon }_{\text{occ}}-{\epsilon }_i)\delta ({\epsilon }_{\text{unocc}}-{\epsilon }_a)$ and

• yield_total_dists (bool) – The results should include the contributions the total energy and Coulomb energy broadened by electronic transition energy onto the unoccupied energies grid $\sum _{ia}{E}_{ia}\delta (\epsilon -{\omega }_{ia})$ and $\sum _{ia}{E}_{ia}^{\text{C}}\delta (\epsilon -{\omega }_{ia})$

• direction (int | Sequence[int]) – Direction $\hat{\mathit{e}}$ of the polarization of the pulse. Integer 0, 1 or 2 to specify x, y or z, or the direction vector specified as a list of three values. Default: polarization along z.

Return type:

ResultKeys

icalculate(yield_total_E_ia=False, yield_proj_E_ia=False, yield_total_E_ou=False, yield_total_dists=False, direction=2)

Iteratively calculate energies.

Parameters:

• yield_total_E_ia (bool) – The results should include the contributions in the electron-hole basis to the total energy $E_{ia}$ and Coulomb energy $E_{ia}^{\text{c}}$

• yield_proj_E_ia (bool) – The results should include the contributions in the electron-hole basis to the total energy projected on the occupied and unoccupied Voronoi weights $E_{ia}{w}_i$ and $E_{ia}{w}_a$.

• yield_total_E_ou (bool) – The results should include the contributions the total energy broadened on the occupied and unoccupied energy grids $\sum _{ia}{E}_{ia}\delta ({\epsilon }_{\text{occ}}-{\epsilon }_i)\delta ({\epsilon }_{\text{unocc}}-{\epsilon }_a)$ and

• yield_total_dists (bool) – The results should include the contributions the total energy and Coulomb energy broadened by electronic transition energy onto the unoccupied energies grid $\sum _{ia}{E}_{ia}\delta (\epsilon -{\omega }_{ia})$ and $\sum _{ia}{E}_{ia}^{\text{C}}\delta (\epsilon -{\omega }_{ia})$

• direction (int | Sequence[int]) – Direction $\hat{\mathit{e}}$ of the polarization of the pulse. Integer 0, 1 or 2 to specify x, y or z, or the direction vector specified as a list of three values. Default: polarization along z.

Yields:

Tuple (work, result) on the root rank of the calculation communicator. Does not yield on non-root ranks of the calculation communicator. –

work

An object representing the metadata (time or pulse) for the work done.

result

Object containg the calculation results for this time and pulse.

Return type:

Generator[tuple[WorkMetadata, Result], None, None]

class rhodent.calculators.HotCarriersCalculator(response, voronoi=None, *, energies_occ=None, energies_unocc=None, sigma=None, times=None, pulses=None, frequencies=None, frequency_broadening=0)

Calculate hot-carrier distributions in the time domain.

For weak perturbations, the response of the density matrix is to first order non-zero only in the occupied-unoccupied space, i.e. the block off-diagonals

$$\begin{array}{r}\delta \rho =\left[\begin{array}{cc}0& [\delta {\rho }_{ai}^{\ast }]\\ [\delta {\rho }_{ia}]& 0\end{array}\right].\end{array}$$

The unoccupied-occupied, or electron-hole, part of the density matrix is thus linear in perturbation and can by transformed using Fourier transforms.

From the first-order response, the second order response, i.e. the hole-hole ($\delta {\rho }_{i{i}^{\prime }}$) and electron-electron ($\delta {\rho }_{a{a}^{\prime }}$) parts can be obtained.

The hole-hole part is

$$\delta {\rho }_{i{i}^{\prime }}=-\frac{1}{2}\sum _n^{f_n>f_i,f_n>f_{i^{\prime }}}{P}_{ni}{P}_{n{i}^{\prime }}+Q_{ni}{Q}_{n{i}^{\prime }}$$

and the electron-hole part

$$\delta {\rho }_{a{a}^{\prime }}=\frac{1}{2}\sum _n^{f_n<f_a,f_n<f_a^{\prime }}{P}_{ia}{P}_{i{a}^{\prime }}+Q_{ia}{Q}_{i{a}^{\prime }}$$

where

$$\begin{array}{r}\begin{array}{rl}{P}_{ia}& =\frac{2\mathrm{Im}\delta {\rho }_{ia}}{\sqrt{2f_{ia}}}\\ Q_{ia}& =\frac{2\mathrm{Re}\delta {\rho }_{ia}}{\sqrt{2f_{ia}}},\end{array}\end{array}$$

where $f_{ia}$ is the occupation number difference of pair $ia$.

Hot-carrier distributions are calculated by convolution of $\delta {\rho }_{i{i}^{\prime }}$ (holes) and $\delta {\rho }_{a{a}^{\prime }}$ (electrons) by Gaussian broadening functions on the energy grid.

$$\begin{array}{r}\begin{array}{rl}{P}^{\text{holes}}(\epsilon )& =\sum _i\delta {\rho }_{i{i}^{\prime }}G(\epsilon -{\epsilon }_i)\\ P^{\text{electrons}}(\epsilon )& =\sum _a\delta {\rho }_{a{a}^{\prime }}G(\epsilon -{\epsilon }_a)\end{array}\end{array}$$

where ${\epsilon }_n$ are Kohn-Sham energies and

$$G(\epsilon -{\epsilon }_n)=\frac{1}{\sqrt{2\pi {\sigma }^2}}\exp (-\frac{{({\epsilon }_i-\epsilon )}^2}{2{\sigma }^2}).$$

Projected hot-carrier distributions are defined

$$\begin{array}{r}\begin{array}{rl}{P}^{\text{holes}}(\epsilon )& =\sum _{i{i}^{\prime }}\delta {\rho }_{i{i}^{\prime }}{w}_{i{i}^{\prime }}G(\epsilon -{\epsilon }_i)\\ P^{\text{electrons}}(\epsilon )& =\sum _{a{a}^{\prime }}\delta {\rho }_{a{a}^{\prime }}{w}_{a{a}^{\prime }}G(\epsilon -{\epsilon }_a).\end{array}\end{array}$$

The Voronoi weights are

$$W_{nn}=⟨{\psi }_n|\hat{w}|{\psi }_n⟩=\int w(\mathit{r}){\psi }_n^{\ast }(\mathit{r}){\psi }_n(\mathit{r})d\mathit{r}$$

where the operator $\hat{w}=w(\mathit{r})$ is 1 in the Voronoi region of the atomic projections and 0 outside.

Parameters:

• response (BaseResponse) – Response object.

• voronoi (Optional[VoronoiWeights]) – Voronoi weights object.

• energies_occ (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Energy grid in units of eV for occupied levels (holes).

• energies_unocc (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Energy grid in units of eV for unoccupied levels (electrons)

• sigma (Optional[float]) – Gaussian broadening width for energy grid in units of eV.

• times (Union[list[float], ndarray[tuple[int, ...], dtype[float64]], None]) – Compute hot carriers in the time domain, for these times (or as close to them as possible). In units of as.

• pulses (Optional[Collection[Union[Perturbation, Laser, dict, None]]]) – Compute hot carriers in the time domain, in response to these pulses. If None no pulse convolution is performed.

calculate_distributions_and_write(out_fname, write_extra={}, average_times=True, only_one_pulse=True)

Calculate broadened hot-carrier energy distributions, optionally averaged over time.

HC distributions are saved in a numpy archive if the file extension is .npz or in a comma separated file if the file extension is .dat.

Parameters:

• out_fname (str) – File name of the resulting data file.

• write_extra (dict[str, Any]) – Dictionary of extra key-value pairs to write to the data file.

• average_times (bool) – If True, an average over the given times will be taken. If false, then hot-carrier distributions are computed separately over the times, and each output is written separately for each time.

• only_one_pulse (bool) – There is only one pulse, don’t group by pulse.

calculate_totals_by_pulse_and_write(out_fname, write_extra={})

Calculate the number of generated hot carriers, projected on groups of atoms, for a list of pulses.

HC numbers are saved in a numpy archive if the file extension is .npz or in a comma separated file if the file extension is .dat.

Parameters:

out_fname (str) – File name of the resulting data file.

calculate_totals_by_time_and_write(out_fname, write_extra={})

Calculate the number of generated hot carriers, projected on groups of atoms, for a list of times.

HC numbers are saved in a numpy archive if the file extension is .npz or in a comma separated file if the file extension is .dat.

Parameters:

out_fname (str) – File name of the resulting data file.

get_result_keys(yield_total_hcdists=False, yield_proj_hcdists=False, yield_total_P=False, yield_proj_P=False, yield_total_P_ou=False)

Get the keys that each result will contain, and dimensions thereof.

Parameters:

• yield_total_hcdists (bool) – The results should include the total hot-carrier distributions on the energy grid.

• yield_proj_hcdists (bool) – The results should include the projections of the hot-carrier distributions on the energy grid.

• yield_total_P (bool) – The results should include the total hot-carrier distributions in the electron-hole basis.

• yield_proj_P (bool) – The results should include the projections of the hot-carrier distributions in the electron-hole basis.

• yield_total_P_ou (bool) – The results should include the transition matrix broadened on the energy grid.

icalculate(yield_total_hcdists=False, yield_proj_hcdists=False, yield_total_P=False, yield_proj_P=False, yield_total_P_ou=False)

Iteratively calculate second order density matrices and hot-carrier distributions.

Parameters:

• yield_total_hcdists (bool) – The results should include the total hot-carrier distributions on the energy grid.

• yield_proj_hcdists (bool) – The results should include the projections of the hot-carrier distributions on the energy grid.

• yield_total_P (bool) – The results should include the total hot-carrier distributions in the electron-hole basis.

• yield_proj_P (bool) – The results should include the projections of the hot-carrier distributions in the electron-hole basis.

• yield_total_P_ou (bool) – The results should include the transition matrix broadened on the energy grid.

Yields:

Tuple (work, result) on the root rank of the calculation communicator. Does not yield on non-root ranks of the calculation communicator. –

work

An object representing the metadata (time and pulse) for the work done.

result

Object containg the calculation results for this time and pulse.

Return type:

Generator[tuple[WorkMetadata, Result], None, None]

Other calculators

These calculators require other input files than the calculators for the full response, for example just the dipole moment file.

class rhodent.dos.DOSCalculator(eigenvalues, fermilevel, voronoi, energies, sigma, zerofermi=False)

Density of states (DOS) and partial DOS (PDOS) calculator.

Calculates DOS

$$\mathrm{DOS}(\epsilon )={\mathrm{\Sigma }}_{n}G(\epsilon -{\epsilon }_n)$$

and PDOS

$$\mathrm{PDOS}(\epsilon )={\mathrm{\Sigma }}_n{w}_{nn}G(\epsilon -{\epsilon }_n)$$

where ${\epsilon }_n$ are Kohn-Sham energies and $G(\epsilon -{\epsilon }_n)$ a Gaussian broadening function

$$G(\epsilon -{\epsilon }_n)=\frac{1}{\sqrt{2\pi {\sigma }^2}}\exp (-\frac{{({\epsilon }_i-\epsilon )}^2}{2{\sigma }^2}).$$

The Voronoi weights are defined

$$W_{nn}=⟨{\psi }_n|\hat{w}|{\psi }_n⟩=\int w(\mathit{r}){\psi }_n^{\ast }(\mathit{r}){\psi }_n(\mathit{r})d\mathit{r}$$

where the operator $\hat{w}=w(\mathit{r})$ is 1 in the Voronoi region of the atomic projections and 0 outside.

Parameters:

• eigenvalues (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – List of eigenvalues ${\epsilon }_n$ (relative to Fermi level).

• fermilevel (float) – Fermi level.

• voronoi (VoronoiWeights | None) –

  Voronoi weights object defining the atomic projections for PDOS.

  Leave out if only DOS is desired.

• energies (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – Array of energies (in units of eV) for which the broadened PDOS is computed.

• sigma (float) – Gaussian broadening width $\sigma$ in units of eV.

• zerofermi (bool) – Eigenvalues relative to Fermi level if True, else relative to vacuum

calculate_dos()

Calculate DOS.

Return type:

DOS on the root rank, None on other ranks.

calculate_dos_and_write(out_fname, write_extra={})

Calculate the DOS and write to file.

The DOS is saved in a numpy archive if the file extension is .npz or in a comma separated file if the file extension is .dat.

Parameters:

• out_fname (Path | str) – File name of the resulting data file.

• write_extra (dict[str, Any]) – Dictionary of additional data written to numpy archive (ignored for .dat) files.

calculate_pdos_and_write(out_fname, write_extra={}, write_extra_from_voronoi=False)

Calculate the PDOS and write to file.

The PDOS is saved in a numpy archive if the file extension is .npz or in a comma separated file if the file extension is .dat.

Parameters:

• out_fname (Path | str) – File name of the resulting data file.

• write_extra (dict[str, Any]) – Dictionary of additional data written to numpy archive (ignored for .dat) files.

• write_extra_from_voronoi (bool) – If true, and voronoi is a ULM reader, extra key-value pairs are read from voronoi and written to the .npz file (ignored for .dat) files.

property energies: ndarray[tuple[int, ...], dtype[float64]]

Energy grid in units of eV.

classmethod from_calc(calc, voronoi, energies, sigma, zerofermi=False)

Initialize from GPAW calculator.

Parameters:

• calc (gpaw.GPAW) – GPAW calculator.

• voronoi (VoronoiWeights | None) –

  Voronoi weights object defining the atomic projections for PDOS.

  Leave out if only DOS is desired.

• energies (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – Array of energies (in units of eV) for which the broadened PDOS is computed.

• sigma (float) – Gaussian broadening width $\sigma$ in units of eV.

• zerofermi (bool) – Eigenvalues relative to Fermi level if True, else relative to vacuum.

classmethod from_gpw(gpw_file, voronoi, energies, sigma, zerofermi=False)

Initialize from .gpw file.

Parameters:

• gpw_file (Path | str) – Filename of GPAW ground state file.

• voronoi (VoronoiWeights | None) –

  Voronoi weights object defining the atomic projections for PDOS.

  Leave out if only DOS is desired.

• energies (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – Array of energies (in units of eV) for which the broadened PDOS is computed.

• sigma (float) – Gaussian broadening width $\sigma$ in units of eV.

• zerofermi (bool) – Eigenvalues relative to Fermi level if True, else relative to vacuum.

icalculate_pdos()

Calculate PDOS for each of the atomic projections in the voronoi object..

Yields:

Once per set of Voronoi weights a dictionary with keys –

• weight_n - Array of dimensions (Nn) of projections. None on non-root ranks.

• pdos_e - Broadened PDOS. None on non-root ranks.

Return type:

Generator[dict[str, ndarray[tuple[int, ...], dtype[float64]] | None], None, None]

property log: Logger

Logger.

property sigma: float

Gaussian broadening width in units of eV.

property voronoi: VoronoiWeights | None

Voronoi weights object.

class rhodent.spectrum.SpectrumCalculator(times, dipole_moments, perturbation)

Spectrum calculator.

Calculates the dynamic polarizability and dipole strength function (the spectrum).

The polarizability $\alpha (\omega )$ is related to the perturbation $\mathcal{E}(\omega )$ and the Fouier transform of the dipole moment $\mathit{\mu }(t)$ as

$$\mathit{\alpha }(\omega )\mathcal{E}(\omega )=\mathcal{F}[\mathit{\mu }(t)](\omega ).$$

The dipole strength function is

$$\mathit{S}(\omega )=\frac{2}{\pi }\omega \mathrm{Im}[\mathit{\alpha }(\omega )].$$

Both quantities can be broadened by supplying a non-zero value $\sigma$. Then the convolution

$$\frac{1}{\sqrt{2\pi /{\sigma }^2}}{\int }_{-\mathrm{\infty }}^{\mathrm{\infty }}\mathit{\alpha }({\omega }^{\prime })\exp (-\frac{(\omega -{\omega }^{\prime }{)}^2}{2{\sigma }^2})\mathrm{d}{\omega }^{\prime }$$

is computed. When the perturbation is a delta-kick, this can efficiently be computed by multiplying the dipole moment by a Gaussian envelope before Fourier transformation

$$\mathit{\mu }(t)\exp (-{\sigma }^2{t}^2/2).$$

For other perturbations, a FFT and IFFT is first performed to obtain the delta-kick response.

Parameters:

• times (ndarray[tuple[int, ...], dtype[float64]]) – Array (length T) of times in units of as.

• dipole_moments (ndarray[tuple[int, ...], dtype[float64]]) – Array (shape (T, 3)) of dipole moments in units of eÅ.

• perturbation (Union[Perturbation, Laser, dict, None]) – The perturbation that was applied in the TDDFT calculation.

calculate_spectrum_and_write(out_fname, frequencies, frequency_broadening=0, write_extra={})

Calculate the dipole strength function (spectrum) and write to file.

The spectrum is saved in a numpy archive if the file extension is .npz or in a comma separated file if the file extension is .dat.

Parameters:

• out_fname (Path | str) – File name of the resulting data file.

• frequencies (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – Array of frequencies for which to calculate the spectrum; in units of eV.

• frequency_broadening (float) – Gaussian broadening width in units of eV. Default (0) is no broadening.

• write_extra (dict[str, Any]) – Dictionary of additional data written to numpy archive (ignored for .dat) files.

property dipole_moments: ndarray[tuple[int, ...], dtype[float64]]

Array of dipole moments, in units of eÅ.

get_dipole_strength_function(frequencies, frequency_broadening=0)

Calculate the dipole strength function (spectrum) in units of 1/eV.

Parameters:

• frequencies (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – Array of frequencies for which to calculate the spectrum; in units of eV.

• frequency_broadening (float) – Gaussian broadening width in units of eV. Default (0) is no broadening.

Return type:

Array of dipole strength function in units of 1/eV. The array has shape (N, 3), where N is length of frequencies.

get_dynamic_polarizability(frequencies, frequency_broadening=0)

Calculate the dynamic polarizability.

Parameters:

• frequencies (list[float] | ndarray[tuple[int, ...], dtype[float64]]) – Array of frequencies for which to calculate the polarizability; in units of eV.

• frequency_broadening (float) – Gaussian broadening width in atomic units. Default (0) is no broadening.

Return type:

Array of dynamic polarizabilities in (eÅ)**2/eV. The array has shape (N, 3), where N is the length of frequencies.

property perturbation: Perturbation

The perturbation that was applied in the TDDFT calculation.

property times: ndarray[tuple[int, ...], dtype[float64]]

Array of times corresponding to dipole moments, in units of as.