Export Data

Geometrical factors

WaveMixings.axis_to_index — Function
axis_to_index(c::Char)

Convert the an axis (x, y, z, X, Y, or Z) to an index number.

Arguments

  • axis: x, y, z, X, Y, or Z.

Returns

Number index: x (1), y (2), or z (3).

source
axis_to_index(c::String)

Convert the an axis (x, y, z, X, Y, or Z) to an index number.

Arguments

  • axis: x, y, z, X, Y, or Z.

Returns

Number index: x (1), y (2), or z (3).

source
WaveMixings.get_geometrical_factors — Function
get_geometrical_factors(vector_e1::AbstractVector{T}, vector_e2::AbstractVector{T},
                        vector_e3::AbstractVector{T}, vector_e4::AbstractVector{T})
                        where {T <: Real}

Compute the geometrical factors needed for the polarisation averaging.

Arguments

  • vector_e1: unitary vector of the 1st laser pulse
  • vector_e2: unitary vector of the 2nd laser pulse
  • vector_e3: unitary vector of the 3rd laser pulse
  • vector_e4: unitary vector of the 4th laser pulse

Returns

Geometrical factors.

source
WaveMixings.reshape_tdm! — Function
reshape_tdm!(self::WaveMixing{T}) where {T <: Real}

Reshape the matrix containing TDMs with compoments x, y, and z.

Arguments

  • self: WaveMixing struct containing the righ_tdm parameter.

Returns

Reshaped in place righ_tdm matrix.

source
reshape_tdm!(tdm_matrix::AbstractMatrix{T}) where {T}

Reshape the matrix containing TDMs with compoments x, y, and z.

Arguments

  • tdm_matrix: matrix with TDMs.

Returns

Reshaped in place TDMs matrix.

source
WaveMixings.tdm_xyz_averaging! — Function
tdm_xyz_averaging!(out::AbstractMatrix{T}, xyz_matrix::AbstractMatrix{T},
                   g_facts::AbstractVector{T}) where {T <: Real}

Orientational averaging of a TDMs matrix with compoments x, y, and z, over its geometrical factors. xyz_matrix has dimentions 3MxN. The out_matrix must have dimentions MxN.

Arguments

  • out_matrix: output of the averaged TDMs over the geometrical factors
  • xyz_matrix: matrix with TDMs
  • g_facts: geometrical factors for averaging

Returns

Updated matrix out_matrix with averaged TDMs.

source
tdm_xyz_averaging!(self::WaveMixing{T}, g_facts::AbstractVector{T}) where {T <: Real}

Orientational averaging of a TDMs matrix with compoments x, y, and z, over its geometrical factors. The TDM matrix stored in the paremater righ_tdm must dimentions 3MxN. The parameter μ is updated with the averaged matrix.

Arguments

  • self: WaveMixing struct containing the righ_tdm parameter.
  • g_facts: geometrical factors for averaging

Returns

Updated matrix out_matrix with averaged TDMs.

source

Misc.

WaveMixings.get_axis_range_polarisation — Function
get_axis_range_polarisation(matrix_size::Integer, axis_start::Integer, step::Integer = 3)

Calculates the indexes of a matrix needed for further calculation, namely for polarisation of a determined axis x (1), y (2), or z (3).

Arguments

  • matrix_size: self-explanatory.
  • axis_start: number 1, 2, or 3 (for x, y, z)

Returns

Matrix indexes. Range{Int64}.

source
WaveMixings.iterator_xyz_product — Function
iterator_xyz_product(xyz::UnitRange{Int64} = 1:3)

Arguments

  • xyz: Three Integer range e.g. 1 2 3.

Returns

Matrix with all possible permutations of xyz.

source
WaveMixings.dot3 — Function
dot3(x::AbstractVecOrMat{T1}, y::AbstractVecOrMat{T2},
     z::AbstractVecOrMat{T3}) where {T1 <: Number, T2 <: Number, T3 <: Number}

Arguments

  • x: Matrix or vector
  • y: Matrix or vector
  • y: Matrix or vector

Returns

Dot product of x y z.

source
WaveMixings._orientational_averaging — Method
_orientational_averaging(tdm::AbstractVector{T},
                        geom_factors::AbstractVector{T}) where {T <: Real}

Computes orientational averaging of a transition dipole moment (x,y,z)

Arguments

  • tdm: transition dipole moment with compoments x, y, and z
  • geom_factors: geometrical factors of the laser pulses

Returns

Averaged transition dipole moment over the random orientations.

Description

This functions computes the orientational averaging of the transition dipole moment over random orientations of molecules in the ensemble. This implementation is the most general, thus it permits many different type of laser pulse configurations. The arrangament of those configurations yield the geometrical factors of the laser pulses, which we compute with the function get_geometrical_factors and pass to this function via the parameter (geom_factors). See get_geometrical_factors for a full description of the geometrical factors and their implementation in WaveMixings.jl (see Ref. [1] formula 135)

\[ \overline{I_{\alpha}^{abcd}} = \frac{1}{30}\left(\textrm{g}_{1}(\boldsymbol{s}) + \textrm{g}_{2}(\boldsymbol{s})+ \textrm{g}_{3}(\boldsymbol{s})\right) \left(I_{\alpha}^{(xxxx)}+I_{\alpha}^{(yyyy)}+I_{\alpha}^{(zzzz)}\right)\]

\[+ \frac{1}{30} \textrm{g}_{1}(\boldsymbol{s}) \left(I_{\alpha}^{(yyxx)}+I_{\alpha}^{(zzxx)}+I_{\alpha}^{(xxyy)}+I_{\alpha}^{(zzyy)} +I_{\alpha}^{(xxzz)}+I_{\alpha}^{(yyzz)}\right)\]

\[+ \frac{1}{30} \textrm{g}_{2}(\boldsymbol{s}) \left(I_{\alpha}^{(yxyx)}+I_{\alpha}^{(zxzx)}+I_{\alpha}^{(xyxy)}+I_{\alpha}^{(zyzy)} +I_{\alpha}^{(xzxz)}+I_{\alpha}^{(yzyz)}\right)\]

\[\frac{1}{30} \textrm{g}_{3}(\boldsymbol{s}) \left(I_{\alpha}^{(yxxy)}+I_{\alpha}^{(zxxz)}+I_{\alpha}^{(xyyx)}+I_{\alpha}^{(zyyz)} +I_{\alpha}^{(xzzx)}+I_{\alpha}^{(yzzy)}\right)\]

Cite

[1] Gelin et.al. Chem.Rev. 2022, 122, 24, 17339

See also get_geometrical_factors.

source
WaveMixings._xyz_matrix_2_vec — Method
xyz_matrix_2_vec(xyz_matrix::AbstractMatrix{T}) where {T <: Real}

Arguments

  • xyz_matrix: (n x m) Matrix with X Y X components organised as rows, i.e. the number of rows is a multiple of 3.

Returns

(n/3 x m) matrix

source
WaveMixings.axis_to_index — Method
axis_to_index(c::Char)

Convert the an axis (x, y, z, X, Y, or Z) to an index number.

Arguments

  • axis: x, y, z, X, Y, or Z.

Returns

Number index: x (1), y (2), or z (3).

source
WaveMixings.axis_to_index — Method
axis_to_index(c::String)

Convert the an axis (x, y, z, X, Y, or Z) to an index number.

Arguments

  • axis: x, y, z, X, Y, or Z.

Returns

Number index: x (1), y (2), or z (3).

source
WaveMixings.cite — Function
WaveMixings.cite(io::IO = stdout)

Command line output of citation information and bibtex generator for WaveMixings.jl.

source
WaveMixings.copy_wavemix! — Method
copy_wavemix!(dest::WaveMixing, src::WaveMixing)

Arguments

  • dest: destinatary composite of type WaveMixing.
  • src: source composite of type WaveMixing.

Returns

Updates all the fields (parameters) of the composite dest with those of composite src. Faster, safer, and better than deepcopy.

source
WaveMixings.cropped_trajectory — Method
cropped_trajectory(self::WaveMixing, frame::Integer)

Arguments

  • WaveMixing: Six-wave mixing composite containing energies, and oscillators parameters.
  • frame: frame number in the non-adiabatic trajectory.

Returns

Cropped version of the initial trajectory. For the moment only energies, and oscillators are cropped.

source
WaveMixings.dot3 — Method
dot3(x::AbstractVecOrMat{T1}, y::AbstractVecOrMat{T2},
     z::AbstractVecOrMat{T3}) where {T1 <: Number, T2 <: Number, T3 <: Number}

Arguments

  • x: Matrix or vector
  • y: Matrix or vector
  • y: Matrix or vector

Returns

Dot product of x y z.

source
WaveMixings.filter_files_size — Method
filter_files_size(files::AbstractVector{AbstractString}, sizes::AbstractVector{Int},
                  averag_size::Integer)

Gives Vector containg list of Strings of files which size is larger or equal than averag_size. This function expects that the length of files and sizes is the same.

Arguments

  • files: list of output files for the calculation of the signal.
  • sizes: size of the list of output files for the calculation of the signal.
  • averag_size: average size of one file.

Returns

List of files. Vector{String}.

source
WaveMixings.find_index_oscill — Method
find_index_oscill(total_states::Integer, state::Integer)

Arguments

  • total_states: Number of computed higher excitations.
  • state: Current state.

Returns

Array Vector with oscillator indexes.

source
WaveMixings.get_axis_range_polarisation — Function
get_axis_range_polarisation(matrix_size::Integer, axis_start::Integer, step::Integer = 3)

Calculates the indexes of a matrix needed for further calculation, namely for polarisation of a determined axis x (1), y (2), or z (3).

Arguments

  • matrix_size: self-explanatory.
  • axis_start: number 1, 2, or 3 (for x, y, z)

Returns

Matrix indexes. Range{Int64}.

source
WaveMixings.get_filesin_dir — Method
get_filesin_dir(dir::AbstractString; ext::Tuple=())

Find files in directory. If the files extension is passed, it will filters the found files and export only the matching extensions.

Arguments

  • dir: name of directory.
  • ext: file extension to filter for.

Returns

List of files with relative path.

Example

 files = get_filesin_dir("my_data_input")
 files_gs = get_filesin_dir("my_simul_gs"; ext=(".txt", ) )
 files_se = get_filesin_dir("my_dat_script""; ext=(".txt", ".jl") )
source
WaveMixings.get_foldersin_dir — Method
get_foldersin_dir(dir::AbstractString; pattern::Tuple=())

Find directories within a directoty dir matching the pattern variable.

Arguments

  • dir: name of directory.
  • pattern: pattern to match in the search.

Returns

List of directories with relative path.

Example

 files = get_foldersin_dir("my_data_input")
 files_gs = get_foldersin_dir("my_simul_gs",  pattern=("NAMD", ) )
 files_se = get_foldersin_dir("my_dat_script"",  pattern=("NAMD", "TRAJ") )
source
WaveMixings.get_geometrical_factors — Method
get_geometrical_factors(vector_e1::AbstractVector{T}, vector_e2::AbstractVector{T},
                        vector_e3::AbstractVector{T}, vector_e4::AbstractVector{T})
                        where {T <: Real}

Compute the geometrical factors needed for the polarisation averaging.

Arguments

  • vector_e1: unitary vector of the 1st laser pulse
  • vector_e2: unitary vector of the 2nd laser pulse
  • vector_e3: unitary vector of the 3rd laser pulse
  • vector_e4: unitary vector of the 4th laser pulse

Returns

Geometrical factors.

source
WaveMixings.index_sorting — Function
index_sorting(files::AbstractVector{AbstractString}, delimit::AbstractString ="_")

Sort the indexes of output files. The output files must look like: files_bla_bla_001. Similar files such as gs_dyna_mix_1, pre_2, or se_act_traj_999 would work too. The important fact is that the number must be the last part of the file.

Arguments

  • files: list of output files for the calculation of the signal.
  • delimit: delimiter for spliting the name of the file, default _

Returns

Sorted list of indexes. Vector{Int64}.

source
WaveMixings.intensity_profile_xaxis — Method
intensity_profile_xaxis(spectral_matrix::AbstractMatrix{T}) where {T <: Real}

Create intensity profile along the dims = 1 (n) of the m*n matrix.

Argument

  • spectral_matrix: matrix

Returns

Intensity profile as a vector.

source
WaveMixings.intensity_profile_yaxis — Method
intensity_profile_yaxis(spectral_matrix::AbstractMatrix{T}) where {T <: Real}

Create intensity profile along the dims = 2 (m) of the m*n matrix.

Argument

  • spectral_matrix: matrix

Returns

Intensity profile as a vector.

source
WaveMixings.iterator_xyz_product — Function
iterator_xyz_product(xyz::UnitRange{Int64} = 1:3)

Arguments

  • xyz: Three Integer range e.g. 1 2 3.

Returns

Matrix with all possible permutations of xyz.

source
WaveMixings.make2D_door_window! — Method
make2D_door_window!(self::WaveMixing)
make2D_door_window!(esa::WaveMixing, se::WaveMixing)

Arguments

  • self: composite containing window, door and spectral_signal parameters.

  • esa: composite containing window, and spectral_signal parameters.

  • se: composite containing door and spectral_signal parameters.

Returns

2D Doorway-Window signal (spectra). In general this is the 2D pump-probe spectra for given trajectory.

2D Doorway-Window signal (spectra) for the WaveMixing composite (ESA). In general this is the 2D pump-probe spectra for given trajectory.

source
WaveMixings.make_door_window! — Method
make_door_window!(esa::WaveMixing, se::WaveMixing)

Arguments

  • esa: composite containing window, and spectral_signal parameters.
  • se: composite containing door and spectral_signal parameters.

Returns

Doorway-Window signal (spectra) for the WaveMixing composite (ESA). In general this is the pump-probe spectra for given trajectory.

source
WaveMixings.make_door_window! — Method
make_door_window!(self::WaveMixing)

Arguments

  • WaveMixing: composite containing window, door and spectral_signal parameters.

Returns

Doorway-Window signal (spectra). In general this is the pump-probe spectra for given trajectory.

source
WaveMixings.moving_average — Method
moving_average(A::AbstractArray, m::Integer)

Arguments

  • A: Array with elements to average.
  • m: number of elements to average over to. Default is 3.
  • oscillators: vector (1D array) with all the oscillators.

Returns

Array of the same initial size, but averaged over m points.

source
WaveMixings.normalise — Method
normalise(matrix::AbstractMatrix{ComplexF64})
normalise(matrix::AbstractMatrix{T}) where {T <: Real}

Arguments

  • matrix: Complex matrix, genenally from 2D spectra calculations.

Returns

Normalised Real matrix or Real part of Complex matrix i.e. the extreme values are 0 and 1.

source
WaveMixings.pkginfo — Function
pkginfo(io::IO=stdout)

Returns

Information on WaveMixings, dependencies, and system informations.

source
WaveMixings.population — Method
population(trajectory::AbstractMatrix, max_states::Integer)

Arguments

  • trajectory: Matrix with states and energies.
  • max_states: maximum states in trajectory.

Returns

Matrix with populations.

source
WaveMixings.population — Method
population(self::WaveMixing, max_states::Integer)

Arguments

  • WaveMixing: composite containing the energies field.
  • max_states: maximum states in trajectory.

Returns

Matrix with populations.

source
WaveMixings.reshape_tdm! — Method
reshape_tdm!(tdm_matrix::AbstractMatrix{T}) where {T}

Reshape the matrix containing TDMs with compoments x, y, and z.

Arguments

  • tdm_matrix: matrix with TDMs.

Returns

Reshaped in place TDMs matrix.

source
WaveMixings.reshape_tdm! — Method
reshape_tdm!(self::WaveMixing{T}) where {T <: Real}

Reshape the matrix containing TDMs with compoments x, y, and z.

Arguments

  • self: WaveMixing struct containing the righ_tdm parameter.

Returns

Reshaped in place righ_tdm matrix.

source
WaveMixings.six_wm_wrap — Method
six_wm_wrap(fwm::WaveMixing, swm::WaveMixing, frame::Integer)

Arguments

  • WaveMixing: Four-wave mixing composite containing door, and window parameters.
  • WaveMixing: Six-wave mixing composite containing door, and window parameters.
  • frame: frame number in the non-adiabatic trajectory.

Returns

Combined spectral signal of fwm and swm. Simulateously, this spectral signal is saved to the spectral_signal parameter in the fwm WaveMixing composite.

source
WaveMixings.tdm_xyz_averaging! — Method
tdm_xyz_averaging!(out::AbstractMatrix{T}, xyz_matrix::AbstractMatrix{T},
                   g_facts::AbstractVector{T}) where {T <: Real}

Orientational averaging of a TDMs matrix with compoments x, y, and z, over its geometrical factors. xyz_matrix has dimentions 3MxN. The out_matrix must have dimentions MxN.

Arguments

  • out_matrix: output of the averaged TDMs over the geometrical factors
  • xyz_matrix: matrix with TDMs
  • g_facts: geometrical factors for averaging

Returns

Updated matrix out_matrix with averaged TDMs.

source
WaveMixings.tdm_xyz_averaging! — Method
tdm_xyz_averaging!(self::WaveMixing{T}, g_facts::AbstractVector{T}) where {T <: Real}

Orientational averaging of a TDMs matrix with compoments x, y, and z, over its geometrical factors. The TDM matrix stored in the paremater righ_tdm must dimentions 3MxN. The parameter μ is updated with the averaged matrix.

Arguments

  • self: WaveMixing struct containing the righ_tdm parameter.
  • g_facts: geometrical factors for averaging

Returns

Updated matrix out_matrix with averaged TDMs.

source
WaveMixings.@timeout — Macro
timeout(seconds, expr_to_run, expr_when_fails=nothing)
@time seconds expr_to_run() expr_when_fails=nothing

Simple macro to run an expression with a timeout of seconds. If the expr_to_run fails to finish in seconds seconds, expr_when_fails is returned.

Arguments

  • seconds: time in seconds.
  • expr_to_run: Expression or function..
  • expr_when_fails: message when it fails.

Returns

Message if expression/function does not finished within certain time.

Example

x = @timeout 1 begin
    sleep(1.1)
    println("done")
    1
end "failed"


spectra = @timeout 1 long_calculation(Big_matrix) (-1)
source
WaveMixings.esa_wind_2d! — Method
esa_wind_2d(probe::T, Τ::T, ω_T::AbstractMatrix{Real},
            self::WaveMixing, frame::Integer, dephase::T=0.1)

Calculates the ESA Window (eq. 11 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, probe energy, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Absorption Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • probe: a probe pulse energy.
  • Τ: pulse length.
  • ω_T: array of pumped frequencies.
  • frame: frame number in the non-adiabatic trajectory.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (ESA) is updated with all the important information, namely window_2d. The Doorway signal is a Complex Matrix with n-scanned (pump) collums, and a row.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Window formula (see Ref. [1] formula 11) of the excited-state absorption (ESA) reads:

\[W_{\mathrm{I}}^{2D}(\omega_{t},\boldsymbol{R}_{e(T)}(T),\boldsymbol{P}_{e(T)}(T)) = \frac{E_{4}^{2}(\omega_{t}-\omega_{p})|\mu_{ge(T)}(\boldsymbol{R}_{e(T)}(T))|^{2}}{\nu+ i(U_{e(T)g}(\boldsymbol{R}_{e(T)}(T))-\omega_{t})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_wind_2d!, and se_wind_2d!.

source
WaveMixings.esa_wind_2d_lgc! — Method
esa_wind_2d_lgc!(self::WaveMixing, probe::T, Τ::T, ω_T::AbstractMatrix{Real},
                 frame::Integer, dephase::T=0.1)

Calculates the ESA Window (eq. 11 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, probe energy, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Absorption Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • probe: a probe pulse energy.
  • Τ: pulse length.
  • ω_T: array of pumped frequencies.
  • frame: frame number in the non-adiabatic trajectory.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (ESA) is updated with all the important information, namely window_2d. The Doorway signal is a Complex Matrix with n-scanned (pump) collums, and a row.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Window formula (see Ref. [1] formula 11) of the excited-state absorption (ESA) reads:

\[W_{\mathrm{I}}^{2D}(\omega_{t},\boldsymbol{R}_{e(T)}(T),\boldsymbol{P}_{e(T)}(T)) = \frac{E_{4}^{2}(\omega_{t}-\omega_{p})|\mu_{ge(T)}(\boldsymbol{R}_{e(T)}(T))|^{2}}{\nu+ i(U_{e(T)g}(\boldsymbol{R}_{e(T)}(T))-\omega_{t})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_wind_2d!, and se_wind_2d!.

source
WaveMixings.gsb_door_nr2d! — Method
gsb_door_nr2d!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{Real},
              frame::Integer=1, dephase::T=0.1)

Calculates the non-rephased GSB Doorway (eq. 7 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, pump energy, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Groud State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of probed frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (GSB) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-scanned (probe) collums.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Doorway formula (see Ref. [1] formula 7) of the ground state bleach (GSB) reads:

\[D_{0,\alpha}^{NR}(\omega_{\tau},\boldsymbol{R}_{g},\boldsymbol{P}_{g}) = \rho_{g}^{Wig}(\boldsymbol{R}_{g},\boldsymbol{P}_{g}) \sum_{e}\frac{E_{1}^{2}(\omega_{\tau}-\omega_{p})|\mu_{ge}(\boldsymbol{R}_{g})|^{2}}{\nu+ i\xi_{\alpha}(U_{eg}(\boldsymbol{R}_{g})-\omega_{\tau})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_door_r2d!, se_door_r2d!, and se_door_nr2d!.

source
WaveMixings.gsb_door_r2d! — Method
gsb_door_r2d!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{Real},
             frame::Integer=1, dephase::T=0.1)

Calculates the rephased GSB Doorway (eq. 5 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, pump energy, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Groud State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of probed frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • dephase: dephasing parameter. The default gives 0.1 eV.

Returns

The WaveMixing composite (GSB) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-scanned (probe) collums.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Doorway formula (see Ref. [1] formula 5) of the ground state bleach (GSB) reads:

\[D_{0,\alpha}^{R}(\omega_{\tau},\boldsymbol{R}_{g},\boldsymbol{P}_{g}) = \rho_{g}^{Wig}(\boldsymbol{R}_{g},\boldsymbol{P}_{g}) \sum_{e}\frac{E_{1}^{2}(\omega_{\tau}-\omega_{p})|\mu_{ge}(\boldsymbol{R}_{g})|^{2}}{\nu- i\xi_{\alpha}(U_{eg}(\boldsymbol{R}_{g})-\omega_{\tau})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_door_nr2d!, se_door_r2d!, and se_door_nr2d!.

source
WaveMixings.gsb_wind_2d! — Method
gsb_wind_2d!(self::WaveMixing, probe::T, Τ::T, ω_T::AbstractMatrix{Real},
             frame::Integer, dephase::T=0.1)

Calculates the GSB Window (eq. 9 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, probe energy, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Groud State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • probe: a probe pulse energy.
  • Τ: pulse length.
  • ω_T: array of pumped frequencies.
  • frame: frame number in the non-adiabatic trajectory.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (GSB) is updated with all the important information, namely window_2d. The Doorway signal is a Complex Matrix with n-scanned (pump) collums, and n-excited states rows.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Window formula (see Ref. [1] formula 9) of the ground state bleach (GSB) reads:

\[W_{0}^{2D}(\omega_{t},\boldsymbol{R}_{g}(T),\boldsymbol{P}_{g}(T)) = \sum_{e'}\frac{E_{4}^{2}(\omega_{t}-\omega_{p})|\mu_{ge'}(\boldsymbol{R}_{g}(T))|^{2}}{\nu+ i(U_{e'g}(\boldsymbol{R}_{g}(T))-\omega_{t})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also se_wind_2d!, and esa_wind_2d!.

source
WaveMixings.se_2dflex! — Method
se_2dflex!(self::WaveMixing, Τ::T, ω_t::AbstractMatrix{T},
              frame::Integer=1, τ_ν::T=0.05 ) where {T <: Real}

Calculates the 2D-FLEX Window function eq. S4 in Pios JPCL, 8728. 2024) from energies, oscillator strengths, excitation frequency, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain, including changes by broadening the signal. For the available methods check the function spectrum_energy_fourier and gaussian_spectral_flex. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • Τ: pulse length.
  • ω_t: array of excitation frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • τ_ν: inhomogeneous broadening parameter, the default gives 0.05 eV.

Returns

The WaveMixing composite (2D-FLEX) is updated with all the important information, namely window_2d. The Window signal is a Complex Matrix with n-detection frequencies columns.

Description

Two-dimensional (2D) fluorescence-excitation (2D-FLEX) spectroscopy is a recently proposed nonlinear femtosecond technique for the detection of photoinduced dynamics. The method records a time-resolved fluorescence signal in its excitation- and detection-frequency dependence and hence combines the exclusive detection of excited state dynamics (fluorescence) with signals resolved in both excitation and emission frequencies (2D electronic spectroscopy).

The corresponding Doorway formula (see Ref. [1] formula S4) of the 2D fluorescence-excitation (2D-FLEX) reads:

\[ W^{\mathrm{2DF}}(\omega_{t},\boldsymbol{R}_{e}(T),\boldsymbol{P}_{e}(T); e(T) ) = E_{pr}^{2}(\omega_{\mathrm{t}}- U_{\mathrm{e}(T)\mathrm{g}}(\boldsymbol{R}_{\mathrm{e}}(T))) | \mu_{\mathrm{e}(T)\mathrm{g}}(\boldsymbol{R}_{\mathrm{e} }(T))|^{2}.\]

Cite

[1] Pios et.al. J. Phys. Chem. Lett. 2024, 15, 8728

See also se_2dflex!, se_fluorescence! and se_strong_fluorescence!.

source
WaveMixings.se_2dflex! — Method
se_2dflex!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{T},
          frame::Integer=1, τ_ν::T=0.05 ) where {T <: Real}

Calculates the 2D-FLEX Doorway function (eq. S3 in Pios JPCL, 8728. 2024) from energies, oscillator strengths, excitation frequency, frame number, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain and the peak shape broadening. For the available methods check the function spectrum_energy_fourier and gaussian_spectral_flex. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of excitation frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • τ_ν: inhomogeneous broadening parameter, the default gives 0.05 eV.

Returns

The WaveMixing composite (2D-FLEX) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-excited states rows.

Description

Two-dimensional (2D) fluorescence-excitation (2D-FLEX) spectroscopy is a recently proposed nonlinear femtosecond technique for the detection of photoinduced dynamics. The method records a time-resolved fluorescence signal in its excitation- and detection-frequency dependence and hence combines the exclusive detection of excited state dynamics (fluorescence) with signals resolved in both excitation and emission frequencies (2D electronic spectroscopy).

The corresponding Doorway formula (see Ref. [1] formula S3) of the 2D fluorescence-excitation (2D-FLEX) reads:

\[ D^{\mathrm{2DF}}(\omega_{\tau},\boldsymbol{R}_{\mathrm{g}},\boldsymbol{P}_{\mathrm{g}}; e) = \rho_{\mathrm{g}}^{Wig}(\boldsymbol{R}_{\mathrm{g}},\boldsymbol{P}_{\mathrm{g}}) E_{\nu}^{2}(U_{\mathrm{eg}}(\boldsymbol{R}_{\mathrm{g}}) -\omega_{\tau}) E_{pu}^{2}(\omega_{\tau}-\omega_{pu})|\mu_{ge}(\boldsymbol{R}_{\mathrm{g}})|^{2}. \]

Cite

[1] Pios et.al. J. Phys. Chem. Lett. 2024, 15, 8728

See also se_2dflex_lgc!, se_fluorescence! and se_strong_fluorescence!.

source
WaveMixings.se_2dflex_lgc! — Method
se_2dflex_lgc!(self::WaveMixing, Τ::T, ω_t::AbstractMatrix{T},
               frame::Integer=1, τ_ν::T=0.05 ) where {T <: Real}

Calculates the 2D-FLEX Window function eq. S4 in Pios JPCL, 8728. 2024) from energies, oscillator strengths, excitation frequency, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain, including changes by broadening the signal. For the available methods check the function spectrum_energy_fourier and gaussian_spectral_flex. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • Τ: pulse length.
  • ω_t: array of excitation frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • τ_ν: inhomogeneous broadening parameter, the default gives 0.05 eV.

Returns

The WaveMixing composite (2D-FLEX) is updated with all the important information, namely window_2d. The Window signal is a Complex Matrix with n-detection frequencies columns.

Description

Two-dimensional (2D) fluorescence-excitation (2D-FLEX) spectroscopy is a recently proposed nonlinear femtosecond technique for the detection of photoinduced dynamics. The method records a time-resolved fluorescence signal in its excitation- and detection-frequency dependence and hence combines the exclusive detection of excited state dynamics (fluorescence) with signals resolved in both excitation and emission frequencies (2D electronic spectroscopy).

The corresponding Doorway formula (see Ref. [1] formula S4) of the 2D fluorescence-excitation (2D-FLEX) reads:

\[ W^{\mathrm{2DF}}(\omega_{t},\boldsymbol{R}_{e}(T),\boldsymbol{P}_{e}(T); e(T) ) = E_{pr}^{2}(\omega_{\mathrm{t}}- U_{\mathrm{e}(T)\mathrm{g}}(\boldsymbol{R}_{\mathrm{e}}(T))) | \mu_{\mathrm{e}(T)\mathrm{g}}(\boldsymbol{R}_{\mathrm{e} }(T))|^{2}.\]

Cite

[1] Pios et.al. J. Phys. Chem. Lett. 2024, 15, 8728

See also se_2dflex!, se_fluorescence! and se_strong_fluorescence!.

source
WaveMixings.se_2dflex_lgc! — Method
se_2dflex_lgc!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{T},
               frame::Integer=1, τ_ν::T=0.05 ) where {T <: Real}

Calculates the 2D-FLEX Doorway function (eq. S3 in Pios JPCL, 8728. 2024) from energies, oscillator strengths, excitation frequency, frame number, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain and the peak shape broadening. For the available methods check the function spectrum_energy_fourier and gaussian_spectral_flex. Use with Excited State Dynamics.

Arguments

  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of excitation frequencies.
  • WaveMixing: composite containing oscillators, method and energies parameters.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • τ_ν: inhomogeneous broadening parameter, the default gives 0.05 eV.

Returns

The WaveMixing composite (2D-FLEX) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-excited states rows.

Description

Two-dimensional (2D) fluorescence-excitation (2D-FLEX) spectroscopy is a recently proposed nonlinear femtosecond technique for the detection of photoinduced dynamics. The method records a time-resolved fluorescence signal in its excitation- and detection-frequency dependence and hence combines the exclusive detection of excited state dynamics (fluorescence) with signals resolved in both excitation and emission frequencies (2D electronic spectroscopy).

The corresponding Doorway formula (see Ref. [1] formula S3) of the 2D fluorescence-excitation (2D-FLEX) reads:

\[ D^{\mathrm{2DF}}(\omega_{\tau},\boldsymbol{R}_{\mathrm{g}},\boldsymbol{P}_{\mathrm{g}}; e) = \rho_{\mathrm{g}}^{Wig}(\boldsymbol{R}_{\mathrm{g}},\boldsymbol{P}_{\mathrm{g}}) E_{\nu}^{2}(U_{\mathrm{eg}}(\boldsymbol{R}_{\mathrm{g}}) -\omega_{\tau}) E_{pu}^{2}(\omega_{\tau}-\omega_{pu})|\mu_{ge}(\boldsymbol{R}_{\mathrm{g}})|^{2}. \]

Cite

[1] Pios et.al. J. Phys. Chem. Lett. 2024, 15, 8728

See also se_2dflex!, se_fluorescence! and se_strong_fluorescence!.

source
WaveMixings.se_door_nr2d! — Method
se_door_nr2d!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{Real},
              frame::Integer=1, dephase::T=0.1)

Calculates the non-rephased SE Doorway (eq. 8 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, pump energy, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of probed frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (SE) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-scanned (probe) collums, and n-excited states rows.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Doorway formula (see Ref. [1] formula 8) of the stimulated emission (SE) reads:

\[D_{I,\alpha}^{R}(\omega_{\tau},\boldsymbol{R}_{g},\boldsymbol{P}_{g}) = \rho_{g}^{Wig}(\boldsymbol{R}_{g},\boldsymbol{P}_{g}) \frac{E_{1}^{2}(\omega_{\tau}-\omega_{p})|\mu_{ge}(\boldsymbol{R}_{g})|^{2}}{\nu+ i\xi_{\alpha}(U_{eg}(\boldsymbol{R}_{g})-\omega_{\tau})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_door_r2d!, gsb_door_nr2d!, and se_door_r2d!.

source
WaveMixings.se_door_nr2d_lgc! — Method
se_door_nr2d_lgc!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{Real},
                  frame::Integer=1, dephase::T=0.1)

Calculates the non-rephased SE Doorway (eq. 8 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, pump energy, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Dynamics.

Arguments

  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of probed frequencies.
  • WaveMixing: composite containing oscillators, method and energies parameters.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (SE) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-scanned (probe) collums, and n-excited states rows.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Doorway formula (see Ref. [1] formula 8) of the stimulated emission (SE) reads:

\[D_{I,\alpha}^{R}(\omega_{\tau},\boldsymbol{R}_{g},\boldsymbol{P}_{g}) = \rho_{g}^{Wig}(\boldsymbol{R}_{g},\boldsymbol{P}_{g}) \frac{E_{1}^{2}(\omega_{\tau}-\omega_{p})|\mu_{ge}(\boldsymbol{R}_{g})|^{2}}{\nu+ i\xi_{\alpha}(U_{eg}(\boldsymbol{R}_{g})-\omega_{\tau})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_door_r2d!, gsb_door_nr2d!, and se_door_r2d!.

source
WaveMixings.se_door_r2d! — Method
se_door_r2d!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{Real},
            frame::Integer=1, dephase::T=0.1)

Calculates the rephased SE Doorway (eq. 6 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, pump energy, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of probed frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (SE) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-scanned (probe) collums, and n-excited states rows.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Doorway formula (see Ref. [6] formula 7) of the stimulated emission (SE) reads:

\[D_{I,\alpha}^{R}(\omega_{\tau},\boldsymbol{R}_{g},\boldsymbol{P}_{g}) = \rho_{g}^{Wig}(\boldsymbol{R}_{g},\boldsymbol{P}_{g}) \frac{E_{1}^{2}(\omega_{\tau}-\omega_{p})|\mu_{ge}(\boldsymbol{R}_{g})|^{2}}{\nu- i\xi_{\alpha}(U_{eg}(\boldsymbol{R}_{g})-\omega_{\tau})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_door_r2d!, gsb_door_nr2d!, and se_door_nr2d!.

source
WaveMixings.se_door_r2d_lgc! — Method
se_door_r2d_lgc!(self::WaveMixing, pump::T, Τ::T, ω_T::AbstractMatrix{Real},
                frame::Integer=1, dephase::T=0.1)

Calculates the rephased SE Doorway (eq. 6 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, pump energy, etc. as input. The Doorway is calculated from the 1st data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • pump: a pump pulse energy.
  • Τ: pulse length.
  • ω_T: array of probed frequencies.
  • frame: frame number in the non-adiabatic trajectory. The default gives 1.
  • dephase: dephasing parameter. the default gives 0.1 eV.

Returns

The WaveMixing composite (SE) is updated with all the important information, namely door_2d. The Doorway signal is a Complex Matrix with n-scanned (probe) collums, and n-excited states rows.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Doorway formula (see Ref. [6] formula 7) of the stimulated emission (SE) reads:

\[D_{I,\alpha}^{R}(\omega_{\tau},\boldsymbol{R}_{g},\boldsymbol{P}_{g}) = \rho_{g}^{Wig}(\boldsymbol{R}_{g},\boldsymbol{P}_{g}) \frac{E_{1}^{2}(\omega_{\tau}-\omega_{p})|\mu_{ge}(\boldsymbol{R}_{g})|^{2}}{\nu- i\xi_{\alpha}(U_{eg}(\boldsymbol{R}_{g})-\omega_{\tau})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_door_r2d!, gsb_door_nr2d!, and se_door_nr2d!.

source
WaveMixings.se_wind_2d! — Method
se_wind_2d!(self::WaveMixing, probe::T, Τ::T, ω_T::AbstractMatrix{Real},
            frame::Integer, dephase::T=0.1)

Calculates the SE Window (eq. 10 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, probe energy, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • probe: a probe pulse energy.
  • Τ: pulse length.
  • ω_T: array of pumped frequencies.
  • frame: frame number in the non-adiabatic trajectory.
  • dephase: dephasing parameter. The default gives 0.1 eV.

Returns

The WaveMixing composite (SE) is updated with all the important information, namely window_2d. The Doorway signal is a Complex Matrix with n-scanned (pump) collums, and row.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Window formula (see Ref. [1] formula 10) of the stimulated emission (SE) reads:

\[W_{\mathrm{I}}^{2D}(\omega_{t},\boldsymbol{R}_{e(T)}(T),\boldsymbol{P}_{e(T)}(T)) = \frac{E_{4}^{2}(\omega_{t}-\omega_{p})|\mu_{ge(T)}(\boldsymbol{R}_{e(T)}(T))|^{2}}{\nu+ i(U_{e(T)g}(\boldsymbol{R}_{e(T)}(T))-\omega_{t})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_wind_2d!, and esa_wind_2d.

source
WaveMixings.se_wind_2d_lgc! — Method
se_wind_2d_lgc!(self::WaveMixing, probe::T, Τ::T, ω_T::AbstractMatrix{Real},
                frame::Integer, dephase::T=0.1)

Calculates the SE Window (eq. 10 in Xiang JPCL, 11738. 2021) from energies, oscillator strengths, probe energy, frame number, etc. as input. The Window is calculated from the n-th data point of the trajectory. The signal is calculated from the spectrum energy in the frequency domain. For the available methods check the function spectrum_energy_fourier. Use with Excited State Dynamics.

Arguments

  • WaveMixing: composite containing oscillators, method and energies parameters.
  • probe: a probe pulse energy.
  • Τ: pulse length.
  • ω_T: array of pumped frequencies.
  • frame: frame number in the non-adiabatic trajectory.
  • dephase: dephasing parameter. The default gives 0.1 eV.

Returns

The WaveMixing composite (SE) is updated with all the important information, namely window_2d. The Doorway signal is a Complex Matrix with n-scanned (pump) collums, and row.

Description

In 2D spectroscopy, the pump pulse of PP spectroscopy is replaced by a pair of phase-coherent excitation pulses. The first pulse establishes a coherence between the electronic ground state and the bright excited electronic state. The second pulse, which is delayed by the so-called coherence time $\tau$$, converts the coherence into populations of the ground state and the excited state. By monitoring the correlation of two transition frequencies and its evolution with the waiting time, 2D spectroscopy provides dynamical information which is not exposed in one-dimensional (PP) spectroscopies.

The corresponding Window formula (see Ref. [1] formula 10) of the stimulated emission (SE) reads:

\[W_{\mathrm{I}}^{2D}(\omega_{t},\boldsymbol{R}_{e(T)}(T),\boldsymbol{P}_{e(T)}(T)) = \frac{E_{4}^{2}(\omega_{t}-\omega_{p})|\mu_{ge(T)}(\boldsymbol{R}_{e(T)}(T))|^{2}}{\nu+ i(U_{e(T)g}(\boldsymbol{R}_{e(T)}(T))-\omega_{t})}\]

Cite

[1] Huand et.al. J. Phys. Chem. Lett. 2021, 12, 11736−11788

See also gsb_wind_2d!, and esa_wind_2d!.

source
WaveMixings.WaveMixing — Type
WaveMixing(
           delta_door, delta_window, door, door_2d, energies, left_moment, left_angmom,
           method, oscillators, righ_moment, righ_angmom, delta_spectral_signal,
           spectral_signal, spectral_signal_2d, spectrum_energy, window, window_2d,
           xyz_dipole, xyz_angmom, D2, D3, D4, D5, ΔE, Δω, λ, μ, χ
          )

Composite WaveMixing containing properties for the and from the calculation of a signal.

Arguments

  • delta_door: delta signal for the Door.
  • delta_window: delta signal for the Window.
  • door: Door signal.
  • door_2d: Door signal for 2D.
  • energies: extracted energies from output data.
  • left_angmom: extracted left transition angular moment components.
  • left_tdm: extracted left transition dipole moment components.
  • method: envelope calculation method, by default is Gaussian (gaus)
  • oscillators: extracted oscillators from output data.
  • righ_tdm: extracted right transition dipole moment components.
  • righ_angmom: extracted right transition angular moment components.
  • delta_spectral_signal: delta spectra from the Doorway-Window calculation.
  • spectral_signal: spectra from the Doorway-Window calculation.
  • spectral_signal_2d: spectra from the Doorway-Window calculation for 2D.
  • spectrum_energy: spectrum energy in the frequency domain.
  • window: Window signal.
  • window_2d: Window signal for 2D.
  • xyz_dipole: extracted XYZ dipole moment components.
  • xyz_angmom: extracted XYZ angular moment components.
  • D2: second-order dispersion, AKA group delay dispersion (GDD).
  • D3: third-order dispersion (TOD).
  • D4: fourth-order dispersion (FOD).
  • D5: fiveth-order dispersion (FivOD).
  • γ_0: dimensionless function of the coupling strength.
  • ΔE: energy difference initial energy and the excited energies.
  • Δω: energy difference with the pulse.
  • λ: laser amplitude.
  • μ: transition dipole moments.
  • χ: chirp amplitude, or cavity resonance.
  • 𝛚_c: cavity mode energy / cavity angular frequency.
source
WaveMixings.fs2toau2 — Method
fs2toau2(femto::AbstractFloat)

Converts a time value given in femtoseconds squared, to atomic units squared.

Arguments

-femto: a single numerical value.

Returns

Time in squared atomic units.

source
WaveMixings.fs3toau3 — Method
fs3toau3(femto::AbstractFloat)

Converts a time value given in femtoseconds cubic, to atomic units cubic.

Arguments

-femto: a single numerical value.

Returns

Time in cubic atomic units.

source
WaveMixings.make_nth_order_dispersion — Method
make_nth_order_dispersion(time::AbstractFloat, order::Integer)

Converts the pulse duration given in fs^n to au^n.

Arguments

  • time: pulse duration in fs^n.
  • n: dispersion order.

Returns

Pulse duration in au^n.

source
WaveMixings.make_probe_freq — Method
make_probe_freq(start, stop, steps::Integer)

Creates a vector from start to stop at an interval step. This function ensures that the vector is of type Float64, thus speeding calculations.

Arguments

  • start: starting value of the frequency.
  • stop: ending value of the frequency.
  • steps: frequency intervals to compute.

Returns

Vector (1D array) with all the probe frequency values.

source
WaveMixings.make_pulse_duration — Method
make_pulse_duration(time::Real)

Converts the pulse duration given in fs to au.

Arguments

  • time: pulse duration in fs.

Returns

Pulse duration in au.

source
WaveMixings.make_pump_amplitude — Method
make_pump_amplitude(amplitude::Real)

Converts the pump amplitude given in eV to Hartree.

Arguments

  • amplitude: pump amplitude.

Returns

Pump amplitude in Hartree unit.

source
WaveMixings.make_pump_freq — Method
make_pump_freq(freq::Real)

Converts the pump frequency given in eV to Hartree.

Arguments

  • freq: pump frequency.

Returns

Pump frequency in Hartree unit.

source
WaveMixings.make_axis_probe — Method
make_axis_probe(probe::Matrix{AbstractFloat})

Create Array with probe indexes. Use as input the probe Array used in the TAPP simulations.

Arguments

  • probe: probe pulse energies.

Returns

Sorted Array of prove indexes in eV .

source
WaveMixings.make_axis_time — Method
make_axis_time(spectral_signal::Matrix{AbstractFloat}, start::AbstractFloat = 0.0,
               Δ_time::AbstractFloat = 0.5)

Create Array with time steps. Useful function to create time indexes used in plots.

Arguments

  • spectral_signal: spectral signal Matrix, results from the doorway-window calculation.
  • start: starting time. Default is 0.0 fs
  • Δ_time: simulation time step. Default is 0.5 fs

Returns

Sorted list of time indexes from start.

source
WaveMixings._extract_data_esa_nx — Method
_extract_data_esa_nx(energy_dat::AbstractString, oscillator_dat::AbstractString,
active_states::AbstractVector{Real})

PRIVATE FUNCTION to read NEWTON-X input files on ESA. Extract the data (energies and oscillators) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the esa function to calculate the signal. i.e. Excited State Absorption. Note: ESA simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • active_states: Array with states.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings._extract_data_esa_py — Method
_extract_data_esa_py(energy_dat::AbstractString, oscillator_dat::AbstractString,
                     active_states::AbstractVector{Real})

PRIVATE FUNCTION to read ZagHop input files on ESA. Extract the data (energies and oscillators) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the esa function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). This function is for the extraction data of the excited state absorption i.e. Excited State Absorption. Note: ESA simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • active_states: Array with states.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings._extract_data_esa_sc — Method
_extract_data_esa_sh(energy_dat::AbstractString, oscillator_dat::AbstractString,
active_states::AbstractVector{Real})

PRIVATE FUNCTION to read SHARC input files on ESA. Extract the data (energies and oscillators) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the esa function to calculate the signal. i.e. Excited State Absorption. Note: ESA simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • active_states: Array with states.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings._extract_data_esa_zh — Method
_extract_data_esa_zh(energy_dat::AbstractString, oscillator_dat::AbstractString,
                     active_states::AbstractVector{Real})

PRIVATE FUNCTION to read ZagHop input files on ESA. Extract the data (energies and oscillators) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the esa function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). This function is for the extraction data of the excited state absorption i.e. Excited State Absorption. Note: ESA simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • active_states: Array with states.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings._extract_data_gs_nx — Method
_extract_data_gs_nx(energy_dat::AbstractString, oscillator_dat::AbstractString)

PRIVATE FUNCTION to read NEWTON-X input files on GSB. Extract the data (energies and dipoles) from the simulation output folder, to later estimate the pump probe signal. The output of this function can be passed directly to the gs function to calculate the signal. Note: GSB simulations are stable so we filter the time steps for all imported files. THIS IS NOT THE CASE FOR SE.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings._extract_data_gs_sc — Method
_extract_data_gs_sh(energy_dat::AbstractString, oscillator_dat::AbstractString)

PRIVATE FUNCTION to read SHARC input files on GSB. Extract the data (energies and dipoles) from the simulation output folder, to later estimate the pump probe signal. The output of this function can be passed directly to the gs function to calculate the signal. Note: GSB simulations are stable so we filter the time steps for all imported files. THIS IS NOT THE CASE FOR SE.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings._extract_data_gs_zh — Method
_extract_data_gs_zh(energy_dat::AbstractString, oscillator_dat::AbstractString)

PRIVATE FUNCTION to read ZagHop input files on GSB. Extract the data (energies and dipoles) from the simulation output folder, to later estimate the pump probe signal. The output of this function can be passed directly to the gs function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). Note: GSB simulations are stable so we filter the time steps for all imported files. THIS IS NOT THE CASE FOR SE.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings._extract_data_se_nx — Method
_extract_data_se_nx(energy_dat::AbstractString, oscillator_dat::AbstractString)

PRIVATE FUNCTION to read NEWTON-X input files on SE. Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the se function to calculate the signal. This function is for the extraction data of the stimulated emission i.e. Excited State Dynamics. Note: SE simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings._extract_data_se_sc — Method
_extract_data_se_sh(energy_dat::AbstractString, oscillator_dat::AbstractString)

PRIVATE FUNCTION to read SHARC input files on SE. Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the se function to calculate the signal. This function is for the extraction data of the stimulated emission i.e. Excited State Dynamics. Note: SE simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings._extract_data_se_zh — Method
_extract_data_se_zh(energy_dat::AbstractString, oscillator_dat::AbstractString)

PRIVATE FUNCTION to read ZagHop input files on SE. Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the se function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). This function is for the extraction data of the stimulated emission i.e. Excited State Dynamics. Note: SE simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings._import_data — Method
_import_data(energy_dat::AbstractString, tdm_dat::AbstractString)

Universal function to import energies and transition dipole moments in the format required by WaveMixings.

source
WaveMixings.clean_time_steps — Method
clean_time_steps(raw_data::Matrix{T}) where {T <: Real}

Find indexes with unique time steps from dynamic simulations. Intended to use with matrixes where the time steps are in the first collumn.

Arguments

  • raw_data: Matrix with the sequence of time steps in the 1st collumn

Returns

  • Indexes with the last unique data points of a time series.
source
WaveMixings.extract_data_esa — Method
extract_data_esa(active_states::Vector{Float64}, input_trajectory::AbstractString)

Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the esa function to calculate the signal. This function also test whether the input file exist. This function is mainly done for better understanding of the extraction data of the excited state absorption i.e. Excited State Absorption.

In future the function could be update to be form closures.

Arguments

  • active_states: array (vector) listing the active state in a

determined time step.

  • input_trajectory: name of the input data, i.e. the output of

dynamics.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings.extract_data_esa — Method
extract_data_esa(energy_dat::AbstractString, oscillator_dat::AbstractString,
                 active_states::AbstractVector{Real},
                 hopping_softw::Symbol = :zh)

Extract the data (energies and oscillators) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the esa function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). This function is for the extraction data of the excited state absorption i.e. Excited State Absorption. Note: ESA simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • active_states: Array with states.
  • hopping_softw: keyword decribing the surface hopping software of the

simulations. :zg - ZagHop, :nx - Newton-X, and :sh - SHARC.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings.extract_data_gs — Function
extract_data_gs(energy_dat::AbstractString, oscillator_dat::AbstractString,
                hopping_softw::Symbol = :zh)

Extract the data (energies and dipoles) from the simulation output folder, to later estimate the pump probe signal. The output of this function can be passed directly to the gs function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). Note: GSB simulations are stable so we filter the time steps for all imported files. THIS IS NOT THE CASE FOR SE.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • hopping_softw: keyword decribing the surface hopping software of the

simulations. :zg - ZagHop, :nx - Newton-X, and :sh - SHARC.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings.extract_data_gs — Method
extract_data_gs(input_trajectory::AbstractString)

Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be past directly to the signal_pp function to calculate the signal. This function also test whether the input file exist.

In future the function could be update to be form closures.

Arguments

  • input_trajectory: name of the input data, i.e. the output of dynamics.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings.extract_data_se — Function
extract_data_se(energy_dat::AbstractString, oscillator_dat::AbstractString,
                hopping_softw::Symbol = :zh)

Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the se function to calculate the signal. This function test whether the input files exist, and assuming that most files are within the folder where energy_dat is, it tries to load data from dipole_xyz.dat (xyz_dipole), left_dipole.dat (left_tdm), right_dipole.dat (righ_tdm), angmom_xyx.dat (xyz_angmom), left_angmom.dat (left_angmom), and right_angmom.dat (righ_angmom). This function is for the extraction data of the stimulated emission i.e. Excited State Dynamics. Note: SE simulations might be unstable so we DO NOT filter the time steps for extra imported files (right..., left..., angmom...). DO THIS LATER AFTER IMPORTING with clean_time_steps

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • oscillator_dat: name of the input data containing oscillators.
  • hopping_softw: keyword decribing the surface hopping software of the

simulations. :zg - ZagHop, :nx - Newton-X, and :sh - SHARC.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation. If the more data files are available, WaveMixing might contain xyz_dipole, left_tdm, righ_tdm, xyz_angmom, left_angmom, righ_angmom.

source
WaveMixings.extract_data_se — Method
extract_data_se(input_trajectory::AbstractString)

Extract the data (energies and dipoles) from the simulation output, to later estimate the pump probe signal. The output of this function can be passed directly to the se function to calculate the signal. This function also test whether the input file exist. This function is mainly done for better understanding of the extraction data of the stimulated emission i.e. Excited State Dynamics.

In future the function could be update to be form closures.

Arguments

  • input_trajectory: name of the input data, i.e. the output of

dynamics.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings.extrapolate_empty_data — Method
extrapolate_empty_data(self::WaveMixing)

Extrapolate the zero (0.0) data registered within collums. This minimises the visual effect from the missing data when plotting the signals, as well as avoids unwanted NaNs.

In future the function could be update to be form closures.

Arguments

  • WaveMixing: composite containing oscillators and energies parameters.

Returns

  • WaveMixing composition (struct) containing energy and oscillators

with the extrapolated data.

source
WaveMixings.get_number_E_per_step — Method
get_number_E_per_step(output_dynamics::AbstractString)

Get the number of calculated energies in ONE time step of a simulation. This function is done for optimisation of the code and to later expand the code if needed.

Arguments

  • output_dynamics: name of the input data, i.e. the output of

dynamics.

Returns

  • (length_data), a number indicating the number of energies

calculated in a single simulation time step.

source
WaveMixings.import_ESA — Method
import_ESA(energy_dat::AbstractString, tdm_dat::AbstractString)

Imports the data (energies and transition dipole moments) from surface-hopping simulations. The output of this function needs to be orientational averaged before being passed to the esa function to calculate the signal. i.e. Excited State Absorption. Note: ESA simulations might be unstable, thus we filter the time steps to be extra cautious of the results.

In future the function could be update to be form closures.

Arguments

  • energy_dat: name of the input data containing energies.
  • tdm_dat: name of the input data containing transition dipole moments.
  • active_states: Array with states.

Returns

  • WaveMixing composition (struct) containing energy and righ_tdm

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings.import_GS — Method
import_GS(energy_dat::AbstractString, tdm_dat::AbstractString)

Imports the data (energies and transition dipole moments) from surface-hopping simulations. The output of this function needs to be orientational averaged before being passed to the gs function to calculate the signal. Note: GSB simulations are stable but we filter the time steps for all imported files, just to be sure. THIS IS NOT THE CASE FOR SE.

Arguments

  • energy_dat: name of the input data containing energies.
  • tdm_dat: name of the input data containing transition dipole moments.

Returns

  • WaveMixing composition (struct) containing energy and righ_tdm

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings.import_SE — Method
import_SE(energy_dat::AbstractString, tdm_dat::AbstractString)

Imports the data (energies and transition dipole moments) from surface-hopping simulations. The output of this function needs to be orientational averaged before being passed to the se function to calculate the signal. This function is for importing data of the stimulated emission i.e. Excited State Dynamics. Note: SE simulations might be unstable, thus we filter the time steps to be extra cautious of the results.

Arguments

  • energy_dat: name of the input data containing energies.
  • tdm_dat: name of the input data containing transition dipole moments.

Returns

  • WaveMixing composition (struct) containing energy and righ_tdm

parameters(2D array). This is the minimal input data for the pump-probe signal estimation.

source
WaveMixings.read_matrix_file — Method
read_matrix_file(file_in::AbstractString)

Read file containing a Matrix. This function is for debug and testing, therefore it makes many assumption. For example only numerical matrix separated by by tabs (`/t).

Arguments

  • file_in: input file with written matrix.

Returns

Matrix from file.

source
WaveMixings.save_matrix_file — Method
save_matrix_file(matrix::AbstractMatrix{T}, file_out::AbstractString) where {T <: Real}

Save commputed Matrix to a file in the current directory. This function will replace (delete) any other file with the same name.

Arguments

  • matrix: numerical matrix.
  • file_out: output file to be written.

Returns

Safe matrix to file.

source
WaveMixings.save_vector_file — Method
save_vector_file(vector::AbstractVector{T}, file_out::AbstractString) where {T <: Real}

Save commputed Vector to a file in the current directory. This function will replace (delete) any other file with the same name.

Arguments

  • vector: numerical vector.
  • file_out: output file to be written.

Returns

Safe vector to file.

source