DynamicsOutputs
Here are all the functions that you can specify in the output tuple when using run_dynamics
. To add more, simply add a new function in the DynamicsOutputs
module.
NQCDynamics.DynamicsOutputs
— ModuleDynamicsOutputs
Defines a set of functions that can be used to calculate outputs for dynamics simulations.
NQCDynamics.DynamicsOutputs.OutputDissociation
— TypeOutput a 1 if the molecule has dissociated, 0 otherwise.
NQCDynamics.DynamicsOutputs.OutputQuantisedDiatomic
— TypeOutput the vibrational and rotational quantum numbers of the final image.
NQCDynamics.DynamicsOutputs.OutputStateResolvedScattering1D
— TypeOutput a ComponentVector
with fields reflection
and transmission
containing the probability of the outcome. Each index in the arrays refers to the adiabatic state.
NQCDynamics.DynamicsOutputs.OutputAdiabaticPopulation
— MethodOutputAdiabaticPopulation(sol, i)
Output the adiabatic population at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputCentroidPosition
— MethodOutputCentroidPosition(sol, i)
Output the position of the ring polymer centroid at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputCentroidVelocity
— MethodOutputCentroidVelocity(sol, i)
Output the velocity of the ring polymer centroid at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputDiabaticPopulation
— MethodOutputDiabaticPopulation(sol, i)
Output the diabatic population at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputDiscreteState
— MethodOutputDiscreteState(sol, i)
Output the discrete state variable at each timestep during the trajectory. This is used for surface hopping simulations and returns the variable that determines the currently occupied adiabatic state.
Requires that the dynamics variable has a field state
.
Use OutputDiabaticPopulation
or OutputAdiabaticPopulation
to get the population estimators.
NQCDynamics.DynamicsOutputs.OutputDynamicsVariables
— MethodOutputDynamicsVariables(sol, i)
Output all of the dynamics variables at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputFinal
— MethodOutput the end point of each trajectory.
NQCDynamics.DynamicsOutputs.OutputInitial
— MethodOutput the first point of each trajectory in DynamicsVariables format. (Useful when using distributions for initial conditions.)
NQCDynamics.DynamicsOutputs.OutputKineticEnergy
— MethodOutputKineticEnergy(sol, i)
Evaluate the classical kinetic energy at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputMappingMomentum
— MethodOutputMappingMomentum(sol, i)
Output the momentum mapping variable at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputMappingPosition
— MethodOutputMappingPosition(sol, i)
Output the position mapping variables at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputPosition
— MethodOutputPosition(sol, i)
Output the position at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputPotentialEnergy
— MethodOutputPotentialEnergy(sol, i)
Output the adiabatic potential energy at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputQuantumSubsystem
— MethodOutputQuantumSubsystem(sol, i)
Output the quantum subsystem at each timestep during the trajectory. Usually this will refer to a wavefunction or density matrix but will depend on the particular dynamics method.
NQCDynamics.DynamicsOutputs.OutputSurfaceHops
— MethodOutput the total number of surface hops during the trajectory
NQCDynamics.DynamicsOutputs.OutputTotalAdiabaticPopulation
— MethodOutputTotalAdiabaticPopulation(sol, i)
Output the total adiabatic population at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputTotalDiabaticPopulation
— MethodOutputTotalDiabaticPopulation(sol, i)
Output the total diabatic population at eah timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputTotalEnergy
— MethodOutputTotalEnergy(sol, i)
Evaluate the classical Hamiltonian at each timestep during the trajectory.
NQCDynamics.DynamicsOutputs.OutputVelocity
— MethodOutputVelocity(sol, i)
Output the velocity at each timestep during the trajectory.