BasisTransformationHAWP¶
About the BasisTransformationHAWP class¶
The WaveBlocks Project
@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016 R. Bourquin @license: Modified BSD License
Inheritance diagram¶
Class documentation¶
-
class
WaveBlocksND.BasisTransformationHAWP(potential, builder=None)[source]¶ This class implements basis transformations of Hagedorn wavepackets
between the canonical basis of and the basis
spanned by the eigenvectors
of the potential
.-
__init__(potential, builder=None)[source]¶ Create a new
BasisTransformationHAWPinstance for a given potential matrix
.Parameters: - potential (A
MatrixPotentialinstance.) – The potential underlying the basis transformation. - builder (A
Quadraturesubclass instance.) – An object that can compute this matrix.
- potential (A
-
set_matrix_builder(builder)[source]¶ Set the matrix builder. It is responsible for computing the matrix elements
. This matrix
is used during the basis transformation.Parameters: builder (A Quadraturesubclass instance.) – An object that can compute this matrix.
-
transform_to_canonical(wavepacket)[source]¶ Transform the wavepacket
given
in the eigenbasis to the canonical basis.Note that this method acts destructively on the given
Wavepacketinstance. If this is not desired, clone the packet before handing it over to this method.Parameters: wavepacket (A Wavepacketsubclass instance.) – The Hagedorn wavepacket to transform.Returns: Another Wavepacketinstance containing the transformed wavepacket
.
-
transform_to_eigen(wavepacket)[source]¶ Transform the wavepacket
given
in the canonical basis to the eigenbasis.Note that this method acts destructively on the given
Wavepacketinstance. If this is not desired, clone the packet before handing it over to this method.Parameters: wavepacket (A Wavepacketsubclass instance.) – The Hagedorn wavepacket to transform.Returns: Another Wavepacketinstance containing the transformed wavepacket
.
-