qpe::BoundStates1D Class Reference

Implements the Bound States1D component. More...

#include <boundstates1d.h>

Static Public Member Functions
static BoundStateSpectrum1D	solve (const PotentialField2D &potential, const BoundStateSolver1DParams &params)
	Performs solve.
static bool	isYInvariant (const PotentialField2D &potential, double tolerance=1.0e-5) noexcept
	Returns whether y invariant.
static std::uint64_t	potentialSignature (const PotentialField2D &potential) noexcept
	Performs potential signature.
static bool	matches (const BoundStateSpectrum1D &spectrum, const PotentialField2D &potential, double mass, double hbar=1.0) noexcept
	Performs matches.
static bool	prepareEigenstate (ComplexField2D &field, const BoundStateSpectrum1D &spectrum, int stateIndex)
	Prepares eigenstate.
static bool	prepareSuperposition (ComplexField2D &field, const BoundStateSpectrum1D &spectrum, int stateIndexA, int stateIndexB, double relativePhaseRadians=0.0)
	Prepares superposition.

Detailed Description

Implements the Bound States1D component.

The class provides one focused service within the QPE architecture and is documented here independently of the experiment-level Help.

Definition at line 82 of file boundstates1d.h.

Member Function Documentation

isYInvariant()

bool qpe::BoundStates1D::isYInvariant ( const PotentialField2D & potential, double tolerance = 1.0e-5 )

staticnoexcept

Returns whether y invariant.

Parameters

potential	Potential field used by the operation.
tolerance	The tolerance value used by the operation.

Definition at line 312 of file boundstates1d.cpp.

Referenced by qpe::tests::runBoundStates1DTests(), and solve().

matches()

bool qpe::BoundStates1D::matches ( const BoundStateSpectrum1D & spectrum, const PotentialField2D & potential, double mass, double hbar = 1.0 )

staticnoexcept

Performs matches.

Parameters

spectrum	The spectrum value used by the operation.
potential	Potential field used by the operation.
mass	The mass value used by the operation.
hbar	The hbar value used by the operation.

Definition at line 366 of file boundstates1d.cpp.

Referenced by MainWindow::prepareConfiguredInitialState(), MainWindow::refreshBoundStateAnalysis(), qpe::tests::runBoundStates1DTests(), and MainWindow::updateCoherentTunnelingAnalysis().

potentialSignature()

std::uint64_t qpe::BoundStates1D::potentialSignature ( const PotentialField2D & potential )

staticnoexcept

Performs potential signature.

Parameters

potential

Potential field used by the operation.

Definition at line 339 of file boundstates1d.cpp.

Referenced by solve().

prepareEigenstate()

bool qpe::BoundStates1D::prepareEigenstate ( ComplexField2D & field, const BoundStateSpectrum1D & spectrum, int stateIndex )

static

Prepares eigenstate.

Parameters

field	Field data to read or modify.
spectrum	The spectrum value used by the operation.
stateIndex	Zero-based index used to select the requested item.

Definition at line 542 of file boundstates1d.cpp.

References qpe::BoundState1D::amplitude, qpe::ComplexField2D::dy(), qpe::ComplexField2D::empty(), qpe::ComplexField2D::height(), qpe::ComplexField2D::normalize(), qpe::BoundStateSpectrum1D::states, qpe::BoundStateSpectrum1D::valid, qpe::ComplexField2D::width(), and qpe::BoundStateSpectrum1D::x.

Referenced by MainWindow::prepareConfiguredInitialState(), qpe::tests::runBoundStates1DTests(), and qpe::tests::runDrivenTwoLevel2DTests().

prepareSuperposition()

bool qpe::BoundStates1D::prepareSuperposition ( ComplexField2D & field, const BoundStateSpectrum1D & spectrum, int stateIndexA, int stateIndexB, double relativePhaseRadians = 0.0 )

static

Prepares superposition.

Parameters

field	Field data to read or modify.
spectrum	The spectrum value used by the operation.
stateIndexA	The state index a value used by the operation.
stateIndexB	The state index b value used by the operation.
relativePhaseRadians	The relative phase radians value used by the operation.

Definition at line 570 of file boundstates1d.cpp.

References qpe::BoundState1D::amplitude, qpe::ComplexField2D::dy(), qpe::ComplexField2D::empty(), qpe::ComplexField2D::height(), qpe::ComplexField2D::normalize(), qpe::BoundStateSpectrum1D::states, qpe::BoundStateSpectrum1D::valid, qpe::ComplexField2D::width(), and qpe::BoundStateSpectrum1D::x.

Referenced by MainWindow::prepareConfiguredInitialState(), qpe::tests::runBoundStates1DTests(), and qpe::tests::runCoherentTunneling2DTests().

solve()

BoundStateSpectrum1D qpe::BoundStates1D::solve ( const PotentialField2D & potential, const BoundStateSolver1DParams & params )

static

Performs solve.

Parameters

potential	Potential field used by the operation.
params	Parameter block to apply.

Definition at line 378 of file boundstates1d.cpp.

References qpe::BoundState1D::amplitude, qpe::BoundStateSpectrum1D::continuumThreshold, qpe::BoundStateSpectrum1D::dx, qpe::PotentialField2D::dx(), qpe::PotentialField2D::empty(), qpe::BoundState1D::energy, qpe::BoundStateSolver1DParams::energyTolerance, qpe::BoundStateSolver1DParams::hbar, qpe::BoundStateSpectrum1D::hbar, qpe::PotentialField2D::height(), qpe::BoundStateSolver1DParams::imaginaryTimeStep, isYInvariant(), qpe::BoundStateSolver1DParams::mass, qpe::BoundStateSpectrum1D::mass, qpe::BoundStateSolver1DParams::maxIterations, qpe::BoundStateSolver1DParams::maxStates, qpe::BoundStateSpectrum1D::message, qpe::BoundState1D::nodeCount, qpe::BoundStateSpectrum1D::potential, potentialSignature(), qpe::BoundState1D::quantumNumber, qpe::BoundStateSpectrum1D::sourceSignature, qpe::BoundStateSpectrum1D::states, qpe::BoundStateSpectrum1D::valid, qpe::PotentialField2D::width(), qpe::BoundStateSpectrum1D::x, qpe::PotentialField2D::xCoordinate(), and qpe::BoundStateSolver1DParams::yInvarianceTolerance.

Referenced by MainWindow::computeBoundStates(), qpe::tests::anonymous_namespace{driventwolevel2d_tests.cpp}::makeSpectrum(), MainWindow::rebuildLandauZenerReference(), MainWindow::rebuildRamseyReference(), qpe::tests::runBoundStates1DTests(), and qpe::tests::runCoherentTunneling2DTests().

---

The documentation for this class was generated from the following files:

• core/quantum/boundstates1d.h
• core/quantum/boundstates1d.cpp